Manual de

Referência e Scripts
Manual de Referência e Scripts
do Elipse E3

Copyright © 1999 - 2025 Elipse Software Ltda. Todos os direitos reservados.

Versão 6.8.148 (04/04/2025)
Sumário
1 Introdução ................................................................................................................................................... 1
1.1 Objetos ................................................................................................................................................... 1
1.2 Scripts .................................................................................................................................................... 1
1.3 Picks ....................................................................................................................................................... 4
1.4 Eventos Definidos pelo Usuário ....................................................................................................... 11
2 Programando no Elipse E3 ...................................................................................................................... 14
2.1 Ambiente de Programação ............................................................................................................... 14
2.2 Declarando Variáveis ......................................................................................................................... 14
2.3 Obtendo Referências aos Objetos .................................................................................................... 15
2.4 Acessando Objetos ............................................................................................................................. 26
2.5 Trabalhando com Coleções ............................................................................................................... 26
2.6 Comando Set ....................................................................................................................................... 27
2.7 E3Globals ............................................................................................................................................. 27
2.8 Eventos, Métodos e Propriedades Gerais dos Objetos .................................................................. 35
3 Bibliotecas do Usuário ............................................................................................................................. 54
3.1 ElipseX ................................................................................................................................................. 54
4 Visualização .............................................................................................................................................. 59
4.1 Viewer .................................................................................................................................................. 59
4.2 Quadros e Divisores ........................................................................................................................... 83
4.3 Telas e Objetos de Tela ...................................................................................................................... 89
4.4 E3Alarm ............................................................................................................................................. 170
4.5 E3Browser ......................................................................................................................................... 194
4.6 E3Chart .............................................................................................................................................. 200
4.7 E3Playback ........................................................................................................................................ 230
4.8 Relatório de Seção ........................................................................................................................... 231
4.9 TrendAnalysis ................................................................................................................................... 259
5 Objetos de Servidor ............................................................................................................................... 262
5.1 Propriedades Comuns ..................................................................................................................... 262
5.2 Alarmes ............................................................................................................................................. 264
5.3 Banco de Dados ................................................................................................................................ 285
5.4 Coleção de Campos de Usuário de Alarmes ................................................................................. 289
5.5 Drivers ............................................................................................................................................... 291
5.6 Fórmulas ........................................................................................................................................... 345
5.7 Históricos .......................................................................................................................................... 347
5.8 Informações do Servidor ................................................................................................................. 354
5.9 Objetos em Tempo de Configuração ............................................................................................. 366
5.10 Objetos em Tempo de Execução do Servidor ............................................................................. 369
5.11 Servidor de Dados .......................................................................................................................... 372
5.12 Storage ............................................................................................................................................ 396
6 Dúvidas Mais Frequentes ...................................................................................................................... 403

I
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 E3 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 E3 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 ajudam 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 o acesso a todas as penas do E3Chart.

1.2 Scripts
A linguagem que o Elipse E3 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 E3 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 executa um
script, um Pick ou uma combinação deles, em uma sequência também pré-definida.
Cada Editor do Elipse E3 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
OPÇÃO DESCRIÇÃO
Seleciona o objeto cujo script é manipulado
Lista de Objetos
Seleciona o evento a ser aplicado ao objeto
Lista de Eventos
Script Adiciona um script associado ao evento

Pick Abrir Tela Adiciona um Pick Abrir Tela

Introdução 1
 OPÇÃO DESCRIÇÃO
Pick Abrir Tela Modal Adiciona um Pick Abrir Tela Modal

Pick Executar Aplicação Adiciona um Pick Executar Aplicação

Pick Carregar Valor Adiciona um Pick Carregar Valor

Pick Inverter Valor Adiciona um Pick Inverter Valor

Pick Imprimir Relatório Adiciona um Pick Imprimir Relatório

Remover script ou Pick selecionado Remove o script ou o Pick selecionado na

Lista de Ações

Mover script ou Pick selecionado para cima Move a ação selecionada para cima na
ordem da Lista de Ações para o evento

Mover script ou Pick selecionado para baixo Move a ação selecionada para baixo na
ordem da Lista de Ações para o evento

AppBrowser Abre a janela do AppBrowser

Procurar Busca por ocorrências de um determinado

texto

Procurar anterior Seleciona na lista de resultados a ocorrência

anterior

Procurar próxima Seleciona na lista de resultados a ocorrência

seguinte

Substituir Substitui as ocorrências encontradas por

outro texto especificado

Compila o script selecionado Compila o script selecionado, mostrando os

erros no painel Mensagens

Compila todos os scripts deste evento Compila todos os scripts associados ao

evento

Compila todos os eventos deste objeto Compila todos os eventos associados ao

objeto

A ordem de execução das ações é de cima para baixo. Para alterar a ordem, pode-se utilizar as opções Mover script
ou Pick selecionado para cima e Mover script ou Pick selecionado para baixo . Utilize a opção Compila o
script selecionado 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 para selecioná-lo no script.

2 Introdução
 Mensagem do compilador

1.2.1 Adicionando um Script

Para adicionar um script a um objeto, siga estes procedimentos:
1. Selecione o objeto para criar o script e clique na aba Scripts.

Aba Scripts
2. Clique em Script para abrir o Editor de Scripts, conforme a figura a seguir.

Introdução 3
 Adicionando um script ao objeto
3. Digite os comandos em VBScript na caixa de edição de texto.

NOTA
Utilize o caractere de sublinhado para acrescentar uma quebra de linha e deixar o código mais legível. O caractere
de sublinhado indica que o código continua na linha subsequente.

O código a seguir contém um exemplo de script.

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.

NOTA
Ao clicar com o botão direito do mouse em qualquer uma das ações descritas anteriormente, abre-se um menu
contextual que possibilita recortar, copiar ou colar scripts 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 estes procedimentos estão ações como trocas de Tela ou atribuição de valores, bastante comuns
na criação de um projeto. Os tópicos a seguir descrevem os Picks disponíveis na aba Scripts.

NOTA
Todas as opções dos Picks que estão disponíveis via menu contextual (através do clique com o botão direito do
mouse) também estão disponíveis utilizando o atalho de teclado SHIFT + F10, que corresponde à tecla de aplicação
ou de menu .

4 Introdução
1.3.1 Abrir Tela
Abre uma determinada Tela ou Quadro.

Configurações do Pick Abrir Tela

Opções disponíveis no Pick Abrir Tela
OPÇÃO DESCRIÇÃO
Abrir a tela Indica qual Tela deve ser aberta

No quadro Indica o Quadro onde a Tela é visualizada. Se estiver em

branco, é o Quadro principal (_top)

Zoom inicial Define o zoom da Tela, quando mostrada

Alinhamento da Tela Define o alinhamento da Tela em relação à área visível.

Os valores possíveis são Utilizar padrão, Forçar
Esquerdo Superior ou Forçar Centralizado

Parâmetro Indica um parâmetro a ser passado na chamada da Tela

Habilitar rolagem da Tela Habilita o uso das barras de rolagem na Tela

Especificar a posição da janela Indica a posição da janela, em pixels

Especificar o tamanho da janela Indica o tamanho da janela, em pixels ou em Himetric

Estilo da janela Abre a caixa de diálogo Estilo de janela

[Link] Caixa de Diálogo Estilo de Janela

Permite configurar o estilo da janela a ser mostrada, definindo título e a disponibilidade das bordas e botões de
fechar, maximizar e minimizar, entre outras opções. Se a opção Usar configuração padrão das janelas está

Introdução 5
selecionada, a aplicação desabilita as opções desta janela e assume a configuração padrão do Viewer, conforme as
opções configuradas na aba Visualizador das propriedades do Viewer.

Caixa de diálogo Estilo da janela

1.3.2 Abrir Tela Modal

Abre uma Tela Modal, isto é, uma Tela que não permite a interação do usuário com outras Telas enquanto esta estiver
ativa.

6 Introdução
 Configurações do Pick Abrir Tela Modal
Opções disponíveis no Pick Abrir Tela Modal
OPÇÃO DESCRIÇÃO
Abrir a tela Seleciona a Tela a ser aberta

Título Define o título da janela. Este texto é concatenado com o

nome da Tela

Zoom inicial Define o zoom da Tela, quando mostrada

Alinhamento da Tela Define o alinhamento da Tela em relação à área visível.

Os valores possíveis são Utilizar padrão, Forçar
Esquerdo Superior ou Forçar Centralizado

Parâmetro Indica um parâmetro a ser passado na chamada da Tela

Habilitar rolagem da Tela Habilita o uso das barras de rolagem na Tela

Especificar a posição da janela Determina a posição, em pixels, do quadro na janela, a

partir do canto superior esquerdo da Tela

Especificar o tamanho da janela Determina a largura e a altura, em pixels ou em Himetric,

da janela

Estilo da janela Abre a caixa de diálogo Estilo de Janela

Introdução 7
1.3.3 Executar Aplicação
Executa uma aplicação específica.

Configurações do Pick Executar Aplicação

Opções disponíveis no Pick Executar Aplicação
OPÇÃO DESCRIÇÃO
Aplicação Clicando-se em pode-se navegar no disco para indicar
o arquivo da aplicação a ser executada

Argumentos Permite especificar argumentos para a chamada da

aplicação

Executar no diretório Determina o diretório de trabalho da aplicação que é

executada

Modo de exibição Determina o tipo de janela de execução da aplicação. Os

valores possíveis são Normal, Maximizado ou
Minimizado

8 Introdução
1.3.4 Carregar Valor
Carrega um valor em um Tag.

Configurações do Pick Carregar Valor

Opções disponíveis no Pick Carregar Valor
OPÇÃO DESCRIÇÃO
Nome do tag Especifica o nome do Tag no qual é carregado o valor.
Pode-se selecionar o Tag no AppBrowser clicando em

Valor Determina o valor que é carregado no Tag. Pode-se

selecionar o tipo de dados clicando na caixa de seleção

1.3.5 Inverter Valor

Permite inverter o valor de um Tag. Se o valor do Tag é igual a Valor1, então o Tag recebe Valor2. Se o valor do Tag
é igual a Valor2, então o Tag recebe Valor1. Se o valor do Tag não é igual a Valor1 nem Valor2, o Tag recebe
Valor1.
É possível colocar tantos Picks Inverter Valor quantos se desejar. Isto permite a verificação de múltiplos valores para
um mesmo Tag ou até mesmo para diversos Tags em um mesmo evento.

Configurações do Pick Inverter Valor

Introdução 9
 Opções disponíveis no Pick Inverter Valor
OPÇÃO DESCRIÇÃO
Nome do tag Clique em para abrir o AppBrowser e selecionar um
Tag

Valor 1 Determina o primeiro valor a comparar. Se o valor do Tag

é igual a Valor1, então o Tag recebe Valor2

Valor 2 Determina o segundo valor a comparar. Se o valor do Tag

é igual a Valor2, então o Tag recebe Valor1

1.3.6 Imprimir Relatório

Permite imprimir um Relatório de Seção em uma impressora ou mostrar em uma Tela.

Configurações do Pick Imprimir Relatório

Opções disponíveis no Pick Imprimir Relatório
OPÇÃO DESCRIÇÃO
Imprimir relatório Permite selecionar um Relatório de Seção para
impressão

Saída Determina o tipo de saída do Relatório de Seção. Os

valores possíveis são Impressora: Envia o Relatório de
Seção para a impressora, que corresponde ao método
Print, ou Tela: Executa uma prévia de impressão do
Relatório de Seção na tela, que corresponde ao método
PrintPreview

Especificar a posição da janela Determina a posição da prévia de impressão, em pixels,

a partir do canto superior esquerdo da janela. Se estes
valores não são definidos, a prévia de impressão é
mostrada na posição (0, 0)

10 Introdução
 OPÇÃO DESCRIÇÃO
Especificar o tamanho da janela Especifica o tamanho da prévia de impressão na janela,
em pixels ou em Himetric. Se estes valores não são
definidos, a prévia de impressão é criada com o
tamanho de 500 por 500 pixels e a janela é aberta
maximizada. Se apenas uma das dimensões é definida,
largura ou altura, a outra dimensão é configurada para
500 pixels e a janela não é aberta maximizada

1.4 Eventos Definidos pelo Usuário

Apesar do Elipse E3 vir com uma extensa gama de eventos, muitas vezes o usuário pode querer criar um evento
específico para uma aplicação.
Um exemplo para a utilização de eventos definidos pelo usuário seria a realização de um cálculo ou tarefa mais
complexa em um objeto quando o evento gerador vem de um outro Tag ou propriedade.
Apesar de se poder criar e executar este mesmo tipo de tarefa a partir do próprio Tag ou da propriedade geradora
do evento, existem vantagens em manter-se um script junto ao objeto que sofre a ação. Dentre elas, pode-se citar o
trabalho adicional necessário para que um objeto aponte para outro, além de facilidades de manutenção, pois se por
algum motivo é necessário modificar ou apagar o Tag ou a propriedade que seja o evento gerador, não é necessário
modificar um segundo objeto.
Outra vantagem é o fato de que se o Tag gerador do evento é apagado, o objeto não perde o script, só é necessário
indicar uma outra fonte geradora daquele evento.
A geração de eventos internos facilita ainda a criação de bibliotecas, pois cada vez que um componente de biblioteca
é inserido em uma aplicação, traz consigo os scripts e cálculos que podem ser necessários, diminuindo o trabalho de
configuração. Para gerar um novo evento interno em um objeto, siga estes procedimentos:
1. Clique em Criar novo evento na lista de eventos da aba Scripts para abrir a janela Novo Evento de Usuário,
mostrada na figura a seguir.

Janela Novo Evento de Usuário

2. Digite um nome para o evento e clique em OK para abrir o Editor do evento de usuário, conforme as figuras a
seguir, que descrevem as opções possíveis para a condição de ocorrência deste evento.

Opção Sempre que a expressão alterar seu valor

Introdução 11
 Opção Sempre que a expressão for verdadeira
3. As opções disponíveis neste Editor estão descritas na tabela a seguir.
Opções disponíveis no Editor de eventos de usuário
OPÇÃO DESCRIÇÃO
Nome Nome que identifica este evento. Esta opção não é
editável, portanto clique em Renomear Evento de
Usuário para modificar o nome do evento

Renomear Evento de Usuário Abre uma janela para modificar o nome do evento

Expressão Expressão geradora deste evento. Clique em para

abrir o AppBrowser para selecionar um Tag ou
propriedade, por exemplo

Remover Evento de Usuário Remove este evento da Lista de Eventos. NOTA: Ao

remover um evento de usuário, todos os scripts
associados a este evento são perdidos

Condição da Ocorrência Especifica qual a condição para que este evento ocorra.
As opções possíveis são Sempre que a expressão for
verdadeira ou Sempre que a expressão alterar seu
valor. No primeiro caso o evento é do tipo etOnEvent (o
evento ocorre no momento em que a expressão é
verdadeira) ou do tipo etWhileEvent (o evento ocorre
ciclicamente, em intervalos pré-definidos). No segundo
caso o evento é do tipo etOnValueChanged (o evento
ocorre sempre que a expressão muda o valor)

Repetir o evento Quando disponível, indica que o evento é do tipo

etWhileEvent, ou seja, o evento se repete enquanto a
expressão é verdadeira. Esta opção só está disponível
quando a opção Condição de Ocorrência está
configurada como Sempre que a expressão for
verdadeira. O intervalo de repetição é configurado na
opção Período (ms)

Período (ms) Intervalo de repetição, em milissegundos, do evento. Esta

opção só está disponível quando a opção Condição de
Ocorrência está configurada como Sempre que a
expressão for verdadeira e a opção Repetir o evento
está selecionada

12 Introdução
 OPÇÃO DESCRIÇÃO
Tratar desconexão como mudança Indica que a conexão ou desconexão da expressão
geradora do evento deve ser tratada como mudança.
Esta opção só está disponível quando a opção Condição
de Ocorrência está configurada como Sempre que a
expressão alterar seu valor

4. Para alterar este evento usando a aba Scripts do objeto, selecione-o na lista de eventos. Um evento de usuário
também pode ser editado usando a opção Editar Associações do menu contextual de um objeto. Na janela Editar
Associações, clique na coluna Conexão correspondente a este evento e, no menu contextual, selecione a opção
Editar para abrir a janela da figura a seguir.

Janela Editar Eventos

Introdução 13
CAPÍTULO
Programando no Elipse E3
2
Apesar de a maioria dos aspectos do VBScript se aplicarem à programação de scripts no Elipse E3, algumas
particularidades devem ser destacadas no que diz respeito às implementações do conceito de orientação a objetos.
O VBScript é uma linguagem baseada no Visual Basic que traz a capacidade de scripting (roteirização) para aplicações
que executam 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 Elipse E3 Viewer, podem compilar scripts e chamar funções, dentre
outros procedimentos. Isto 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 VBScript Language Reference Guide.

2.1 Ambiente de Programação

O ambiente de programação de scripts no Elipse E3 Studio pode ser acessado ao clicar com o botão direito do
mouse em qualquer objeto e selecionar a opção Propriedades. Na aba Scripts do Editor do objeto, pode-se definir
qual evento é o gerador do script. Como visto no capítulo anterior, os tipos de eventos em um objeto do Elipse E3
são os Pré-Definidos e os Definidos pelo Usuário.
Os eventos pré-definidos variam de objeto para objeto, dependendo da utilização e funcionalidade. Um objeto de
Tela, por exemplo, possui eventos relacionados à interface gráfica, tais como Click (utilizado ao clicar em um objeto)
ou DblClick (utilizado com um duplo clique do mouse). Já um objeto como um Driver de Comunicação possui eventos
relacionados à comunicação, tal como OnCommError (utilizado quando há um erro de comunicação). Pode-se
também definir outros eventos para o objeto, como visto anteriormente.
Quando um script é associado a um evento em um objeto, o campo de digitação apresenta uma declaração de
procedimento (procedure), cuja definição é automática e composta do texto a seguir.
Sub NomeDoObjeto_NomeDoEvento()
End Sub

Nesta definição, NomeDoObjeto é o nome do objeto associado e NomeDoEvento é o nome do evento. Os comandos
do script devem estar entre estas duas linhas.
Para ajudar na digitação do script, pode-se utilizar o AppBrowser. Ao selecionar um método ou propriedade, pode-se
utilizar a opção Copiar. O Tag, propriedade ou método selecionado é inserido na posição do cursor na área de
edição do script. O local do cursor é mostrado através de uma animação com seta piscante.

2.2 Declarando Variáveis

É possível declarar variáveis implicitamente ou explicitamente.
Para declarar uma variável implicitamente, use o nome no script. Automaticamente, a variável é criada e inicializada
com o valor da atribuição ou permanece com o valor EMPTY, ou seja, vazia ou sem nenhum valor, caso não receba
nenhum valor antes de ser utilizada.
Esta é uma prática rápida, porém se o script é muito extenso, pode causar confusão e a criação de mais de uma
variável com o mesmo nome, gerando erros no script.
Para declarar variáveis explicitamente, utilize o comando Dim, como no exemplo a seguir.
Dim Temperatura

Pode-se declarar múltiplas variáveis separando cada nome de variável com uma vírgula, como no exemplo a seguir.
Dim Esquerda, Direita, Topo, Base

Em virtude de os scripts no Elipse E3 serem todos associados a um objeto em particular, as variáveis são sempre
locais, válidas apenas para o escopo do script. Para ter-se variáveis públicas ou globais, deve-se criar um Tag Interno
e utilizá-lo para armazenar o valor desejado.

14 Programando no Elipse E3
2.3 Obtendo Referências aos Objetos
Uma das características mais importantes ao se trabalhar com scripts dentro do Elipse E3 é considerar a separação
existente entre os processos que são executados no servidor e aqueles executados na interface do cliente (Elipse E3
Viewer). Para se trabalhar com scripts, pode-se manipular:
· Objetos do servidor através do servidor
· Objetos do servidor através do Elipse E3 Viewer
· Objetos do Viewer através do mesmo Elipse E3 Viewer

No entanto, não se pode manipular diretamente:

· Objetos do Viewer através do servidor, pois isto só é possível através da criação de eventos no Viewer, ligados a
variáveis que estão no servidor
· Objetos de um Viewer a partir de outro Viewer, pois isto só é possível através da criação de eventos ligados a
variáveis que estão no servidor

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 Elipse E3 Viewer está executando ou visualizando e o servidor, e vice-versa. Por isto, todas as atividades,
tanto do servidor como do Elipse E3 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 E3.
Vale repetir que, ao se editar um script, o usuário pode 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 em uma Tela, o caminho é Viewer - Quadro (se
houver) - Tela - Botão.
As localizações de origem de scripts, do ponto de vista da metodologia para acesso dos objetos, são as seguintes:
· Servidor
· Telas e Quadros (Elipse E3 Viewer)
· ElipseX (bibliotecas): podem ser XFolders, XObjects, que executam no servidor, ou XControls, que executam no
Elipse E3 Viewer

2.3.1 Acessando Propriedades do Servidor

Para se acessar um objeto em execução no servidor a partir de um objeto de Tela ou um ElipseX, deve-se usar o
método [Link].
A palavra Application retorna o objeto de aplicação relacionado ao contexto atual do objeto, e o método GetObject
procura no servidor por um objeto dentro de Application com o nome fornecido, conforme o exemplo a seguir.
Sub Button1_Click()
[Link]("Driver1")._
Item("tag001").AllowRead = False
End Sub

Ou ainda conforme o exemplo a seguir.

Sub Button1_Click()
[Link]("Driver1.tag001").AllowRead = False
End Sub

O método Item foi utilizado para, a partir da referência de Driver1, localizar o tag001, pois um Driver é uma coleção
de Tags. Depois de localizado o objeto, as propriedades e métodos podem ser acessados livremente.
Caso alguma outra operação tivesse que ser realizada com Driver1 ou tag001, outra alternativa para o script anterior
seria a do exemplo a seguir.
Sub Retangulo1_Click()
Set obj = [Link]("Driver1")
[Link]("tag001").AllowRead = False
[Link]("tag002").AllowRead = False
End Sub

Programando no Elipse E3 15
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 executa um acesso ao servidor. Através desta técnica,
chamadas desnecessárias ao servidor são evitadas. Este exemplo usa o comando Set, que é 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 para executar comandos, mude a linha de atribuição desta variável.
A palavra Application nos scripts pode indicar tanto funções que são executadas no Elipse E3 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 Elipse E3 Viewer dentro do servidor, assim
como também não é possível executar funções de servidor dentro do Elipse E3 Viewer.

2.3.2 Acessando Propriedades do Elipse E3 Studio

Para acessar um objeto de servidor qualquer em um script que executa no Elipse E3 Studio, pode-se usar a diretiva
[Link]. A palavra Application retorna o objeto de aplicação relacionado ao contexto atual do objeto,
e o método GetObject procura no Domínio carregado no Elipse E3 Studio por um objeto da aplicação ou do
Domínio com o caminho fornecido. No exemplo a seguir, o evento CustomConfig é disparado no Elipse E3 Studio.
Sub XControl1_CustomConfig
[Link]("Dados.TagDemo1").DocString = "Documentação"
End Sub

2.3.3 Acessando Propriedades do Servidor de dentro do Servidor

Caso seja necessário acessar as propriedades de um Tag a partir de outro, origem e destino estão no servidor
ligados via um módulo pai, que é Driver1.
Nesta situação, deve ser usada a propriedade Parent. Isto permite que seja acessado primeiro o objeto pai onde está
o script, para depois descer-se na hierarquia em busca de outro elemento, conforme a figura e o exemplo a seguir.

Driver1 é o objeto pai de Tag1 e

de Tag2

Sub Tag1_OnRead()
[Link]("Tag2").AllowRead = False
End Sub

Estando-se dentro de um grupo, e desejando-se acessar o mesmo Tag2, pode-se aninhar vários comandos Parent,
conforme a figura e o exemplo a seguir.

16 Programando no Elipse E3
 Pasta1 é o objeto pai de Tag1

Sub Tag1_OnRead()
[Link]("Tag2").AllowRead = False
End Sub

2.3.4 Acessando Objetos de uma Tela a partir de um Script na Tela

Deve-se usar somente o método Item, já que os objetos são filhos da Tela, conforme o exemplo a seguir.
Sub Tela1_OnPreShow(vArg)
Item("Retangulo1").Visible = True
End Sub

Retangulo1 é um item da TelaInicial

Programando no Elipse E3 17
2.3.5 Acessando Objetos de uma Tela a partir de um Script em outro
Objeto na Tela
Pode-se usar a propriedade Parent ou o método Screen, conforme a figura e o exemplo a seguir.

TelaInicial é o objeto pai de

Retangulo1 e Retangulo2

Sub Retangulo1_Click()
[Link]("Retangulo2").Visible = True
End Sub

2.3.6 Modificando a Tela ou Objetos de Tela a partir do Servidor

A modificação de um comportamento qualquer em uma Tela só pode ser executada a partir de Associações, em que
o servidor reporta automaticamente para os Elipse E3 Viewers todas as mudanças das variáveis selecionadas, ou
através de uma busca explícita do Elipse E3 Viewer por informações no servidor. Toda a operação de associação da
interface gráfica é realizada do cliente para o servidor, e não do servidor para o cliente. Assim, não é possível
modificar Telas ou objetos de Tela a partir do servidor via scripts, pois cada cliente de dados tem uma cópia diferente
das Telas.
Um exemplo prático é mudar a cor de um Texto na Tela para verde quando um Tag é ligado, ou seja, o valor é
alterado para 1 (um), e para vermelho quando é desligado, ou seja, o valor é alterado para 0 (zero). Neste caso,
deve-se simplesmente criar uma Associação Digital entre a propriedade TextColor de Texto1 com Tag1. Associações
são preferíveis devido à rapidez de execução e simplicidade de manutenção e construção da aplicação.

18 Programando no Elipse E3
 Associando a cor do texto ao valor de Tag1
Uma outra forma de executar o procedimento anterior é criar um script no Viewer que verifique constantemente se
Tag1 mudou ou não de valor, para então mudar a cor do Texto. Este tipo de script é possível de ser realizado, mas
degrada muito a performance da aplicação. Por isto, esta prática não é aconselhável.

2.3.7 Acessando Objetos de um ElipseX a partir do próprio ElipseX

Na criação de um ElipseX, pode-se declarar propriedades (XProperties) e inserir objetos, que podem ser objetos de
Tela (XControl) ou objetos do servidor (XFolder e XObject). Para se acessar as XProperties através de scripts, acesse o
nome da propriedade diretamente.

Programando no Elipse E3 19
 Aba Design

Aba Propriedades
Por exemplo, na figura anterior tem-se o objeto XControl1 com a propriedade Propriedade1, e os objetos Texto1 e
Retangulo1.
A propriedade Propriedade1, do tipo Booleano, pode ser acessada com o script a seguir.
Sub XControl1_OnStartRunning()
XControl1.Propriedade1 = True
End Sub

Ou ainda com o script a seguir.

Sub XControl1_OnStartRunning()
Propriedade1 = True
End Sub

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.

20 Programando no Elipse E3
 Sub XControl1_OnStartRunning()
Item("Texto1").Value = "motor"
Item("Retangulo1").ForegroundColor = RGB(212, 208, 20)
End Sub

2.3.8 Acessando Objetos de um ElipseX Externamente

O acesso externo a um objeto ElipseX só pode ser realizado através das propriedades, utilizando as instâncias
criadas. Não é possível acessar objetos internos diretamente.
Se o ElipseX em questão é um XControl, este se comporta como um objeto de Tela. Por exemplo, considere a
aplicação da figura a seguir.

Exemplo de XControl
Para alterar a propriedade Propriedade1 do XControl pode-se executar o script a seguir no evento Click de um Botão
de Comando.
Sub CommandButton1_Click()
[Link]("XControl11").Propriedade1 = True
End Sub

Ou ainda executar o script a seguir no evento Click de um Botão de Comando.

Sub CommandButton1_Click()
[Link]("XControl11").Propriedade1 = True
End Sub

No caso de um XFolder ou XObject, deve-se inseri-lo em um Servidor de Dados, conforme o exemplo da figura a
seguir.

Exemplo de XObject
Para alterar a propriedade Valor do XObject, use o script a seguir.

Programando no Elipse E3 21
 Sub CommandButton1_Click()
[Link]("Dados.XObject11").Valor = 123
End Sub

Ou ainda o script a seguir.

Sub CommandButton1_Click()
[Link]("Dados").Item("XObject11").Valor = 123
End Sub

Pode-se ainda ter um XControl acessando um XFolder ou XObject, através de uma XProperty. Por exemplo, a figura a
seguir mostra um XControl chamado XControl1 que possui uma propriedade XValor do tipo XObject1, que é o
nome do XObject criado.

XObject

XControl
Cria-se, por exemplo, uma Associação do valor do objeto Texto1 com a propriedade Valor do XObject1. Isso é
realizado através da propriedade XValor, criada no XControl1. Assim, o valor da propriedade Valor do XObject1 é
mostrada no objeto Texto1 do XControl1.

22 Programando no Elipse E3
 Propriedade Valor
No projeto, o vínculo da instância XObject11 à instância XControl11 pode ser realizado através de uma Associação
na propriedade XValor.

Associação na Propriedade XValor

[Link] Exemplo de Criação de um ElipseX

Suponha que determinada aplicação necessite supervisionar e comandar 10 motores. Cada motor precisa ser
representado por um desenho na Tela, que exibe a cor verde quando em operação e vermelho quando desligado.
Também deve ser permitido o comando do motor na Tela, enviando instruções para ligar e desligar, além de exibir a
velocidade.
Uma possibilidade é a criação de um XControl chamado MotorA com as propriedades Estado igual a Boolean e
Velocidade igual a Double, conforme a figura a seguir.

Programando no Elipse E3 23
 Aba Design

Aba Propriedades
1. Para a indicação da cor, a propriedade OverrideFillColor do motor deve estar associada à propriedade Estado
do XControl, através de uma Associação Digital. Configure a propriedade OverrideFillMode para 2 - SolidFill.
2. Para exibir a velocidade, a propriedade Value do Display deve ser associada à propriedade Velocidade do
XControl.
3. O Botão Liga-Desliga troca o valor da propriedade Estado através de uma Associação Simples.

Note que:
· As Associações dentro da biblioteca são internas, e o 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

24 Programando no Elipse E3
 Elipse E3 Viewer
Outra possibilidade, mais abrangente, utiliza um XObject para o motor. Desta forma, todas as informações relativas
aos motores residem em objetos que estão no servidor. Assim, pode-se construir vários tipos de interface para o
motor (XControls) que trazem do servidor, através do XObject, somente as informações necessárias.
Desta maneira, o objeto MotorA teria que ser modificado para apontar para um XObject, ao invés de declarar em si
mesmo todas as propriedades.
1. Crie um XObject chamado MotorADados e declare neste objeto as propriedades Estado e Velocidade.
2. Crie um XControl MotorA que possua apenas uma propriedade, chamada MeusDados, do tipo MotorADados.
3. MotorADados deve ser inserido em uma Pasta de Dados no servidor e corresponde a cada um dos motores.
MotorA, por sua vez, aponta para o MotorADados desejado, e não é necessária a criação de novos Tags.

Configuração no Editor do XObject

Configuração no Editor do XControl

4. A propriedade Estado, associada à propriedade OverrideFillColor do motor, seria [Link].
5. A propriedade Velocidade, associada ao Display, seria [Link].

Programando no Elipse E3 25
2.4 Acessando Objetos
Seguindo o conceito de encapsulamento de programação orientada a objetos, os métodos e propriedades são
associados aos objetos de origem. Isto significa que sempre se deve indicar o objeto do qual se está acessando o
método ou propriedade.

2.4.1 Propriedades
Para referenciar as propriedades de um objeto, deve-se usar o método GetObject. A sintaxe é a seguinte:
[Link]("<objeto>").<propriedade>

Neste caso, <objeto> é o nome do objeto e <propriedade> é o nome da propriedade, conforme o exemplo a seguir.
[Link]("Dados.TempTanque2").Type

Para facilitar a digitação, é aconselhável sempre utilizar o AppBrowser, que já traz a sintaxe correta.

[Link] Propriedade Value

No Elipse E3, muitos objetos possuem uma propriedade em comum chamada Value. Neste caso específico, pode-se
acessar esta propriedade utilizando se o próprio nome do objeto, conforme o exemplo a seguir.
Button1 = False

Que é equivalente ao exemplo a seguir.

[Link] = False

2.4.2 Métodos
A sintaxe a seguir exemplifica a chamada de um método que não precisa de parâmetros.
[Link]("<objeto>").<metodo>

Neste caso, <objeto> é o nome do objeto e <metodo> é o nome do método.

Se o método aceita parâmetros, use a sintaxe a seguir.
[Link]("<objeto>").<metodo>(<parametro>)

Neste caso, <parametro> é o parâmetro a ser passado para o método. Quando houver mais de um parâmetro, utilize
vírgulas para separá-los.
Se o método retorna um resultado, e for desejável guardá-lo, então os parâmetros devem ser colocados
obrigatoriamente entre parênteses, conforme o exemplo a seguir.
<V> =[Link]("<objeto>").<metodo>(<parametro>)

Neste caso, <V> é a variável que recebe o resultado do método.

2.5 Trabalhando com Coleções

Uma Coleção, ou Collection, é um objeto que gerencia um conjunto de objetos similares. Os objetos contidos em uma
coleção são referenciados por índices, semelhante à referência de arrays. Pode-se adicionar ou remover objetos
individuais de uma coleção, conforme o exemplo a seguir.
Sub CommandButton1_Click()
' Adiciona uma Pena no objeto E3Chart1
[Link]("E3Chart1").[Link] "Pena"
End Sub

Sub CommandButton2_Click()
' Remove a primeira Pena
[Link]("E3Chart1").[Link] 0
End Sub

NOTA
O primeiro objeto em uma coleção possui o índice 1 (um).

Todas as coleções possuem uma propriedade em comum chamada Count, que é o número de objetos ou filhos
existentes, conforme o exemplo a seguir.

26 Programando no Elipse E3
 Sub CommandButton1_Click()
' Mostra uma caixa de diálogo com o número de Penas
MsgBox [Link]("E3Chart1").[Link]
End Sub

2.5.1 Acessando Objetos com o Método Item

Toda coleção possui um método Item, que pode ser usado para acessar qualquer objeto dentro da coleção. Este
método aceita um parâmetro Item, que pode ser um número inteiro positivo ou o nome do objeto dentro da coleção.
O exemplo a seguir é um ajuste da cor da segunda Pena de um objeto E3Chart.
Sub CommandButton1_Click()
' Modifica a cor da segunda pena
[Link]("E3Chart1").[Link](2).Color = RGB(212, 208, 20)
End Sub

O mesmo ajuste pode ser obtido com o exemplo a seguir.

Sub CommandButton1_Click()
' Modifica a cor da pena com nome "Pena2"
[Link]("E3Chart1").[Link]("Pena2").Color = RGB(212, 208, 20)
End Sub

Os comandos anteriores são equivalentes, o primeiro indicando o índice da Pena na coleção e o segundo indicando o
nome da Pena.

2.6 Comando Set

O VBScript implementa o conceito de polimorfismo das linguagens orientadas a objeto, permitindo que uma variável
do tipo Variant assuma a forma de um objeto qualquer através do comando Set. Deste modo, a variável funciona
como um ponteiro para o objeto desejado, permitindo acessar os métodos e propriedades, conforme o exemplo a
seguir.
Sub CommandButton1_Click()
Set E3Chart = [Link]("E3Chart1")
[Link](2).Color = RGB(212, 208, 20)
End Sub

Neste exemplo foi executada a mesma tarefa da 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 conforme o exemplo a
seguir.
[Link]("E3Chart1").[Link](2).Color = RGB(212, 208, 20)

Aparentemente não existe vantagem neste caso, pois pode-se realizar todo o procedimento em uma única linha de
código. Porém, se logo adiante 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
[Link]("E3Chart1").[Link](0).Color = RGB(212, 208, 20)
[Link]("E3Chart1").[Link](1).Color = RGB(200, 208, 20)
[Link]("E3Chart1").[Link](2).Color = RGB(100, 208, 20)
End Sub

Sub CommandButton2_Click()
'Exemplo melhor
Set Penas = [Link]("E3Chart1").Pens
[Link](0).Color = RGB(212, 208, 20)
[Link](1).Color = RGB(200, 208, 20)
[Link](2).Color = RGB(100, 208, 20)
End Sub

2.7 E3Globals
O E3Globals é um módulo do Elipse E3 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 as sintaxes E3Globals.<método> ou simplesmente <método>, exceto
no caso do objeto Relatório de Seção, onde a sintaxe E3Globals.<método> é obrigatória.

Programando no Elipse E3 27
2.7.1 Métodos
Esta seção contém informações sobre os métodos do módulo E3Globals.

[Link] BShl
BShl(Value, Bits)
Retorna o valor passado no parâmetro Value deslocado à esquerda 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 zero e 31). Este método está
disponível tanto em Associações quanto em scripts.

NOTA
Este método permite passar um valor de 32 bits sem sinal, no intervalo entre zero e [Link], no parâmetro
Value, mas o valor de retorno é sempre um valor de 32 bits com sinal, no intervalo entre -[Link] e
[Link]. Caso seja utilizado um valor de ponto flutuante, somente a parte inteira deste valor é utilizada.

[Link] 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 zero e 31). O parâmetro
PreserveSign é um Booleano que permite preencher ou não os bits à esquerda com uma cópia do bit de sinal. Se
omitido, preenche os bits à esquerda com zeros. Este método está disponível tanto em Associações quanto em
scripts.

NOTA
Este método permite passar um valor de 32 bits sem sinal, no intervalo entre zero e [Link], no parâmetro
Value, mas o valor de retorno é sempre um valor de 32 bits com sinal, no intervalo entre -[Link] e
[Link]. Caso seja utilizado um valor de ponto flutuante, somente a parte inteira deste valor é utilizada.

[Link] Choose
Choose(Index, Values)
Retorna um dos itens especificados em Values, baseado no parâmetro Index, iniciando em 0 (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.

NOTA
Este método não propaga a qualidade nem a estampa de tempo dos valores. Se uma Associação contém a
expressão Choose(TagIndex, [Link], [Link], [Link]), o resultado é o valor selecionado, porém com
qualidade Boa (192) e estampa de tempo atual. Para que estas informações sejam preservadas, é necessário
especificar somente o objeto, como por exemplo Choose(TagIndex, Tag1, Tag2, Tag3).

[Link] DwordToLong
DwordToLong(Value)
Converte um valor de 32 bits sem sinal, no intervalo entre zero e [Link], passado no parâmetro Value para um
valor de 32 bits com sinal, no intervalo entre -[Link] e [Link], no mesmo padrão de bits. Se o valor
estiver no intervalo entre zero e [Link], o valor é retornado sem mudanças.

NOTA
Caso o valor passado no parâmetro Value seja um valor de ponto flutuante, somente a parte inteira deste valor é
utilizada.

28 Programando no Elipse E3
[Link] 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. Se omitido, mostra a expressão em Value formatada
conforme as configurações de região e idioma do Windows. Este método está disponível tanto em Associações
quanto em scripts.

[Link] E3ProductString
E3ProductString()
Este método retorna uma String contendo o nome e a versão do componente onde é invocado, como por exemplo
"Elipse E3 6.8.148" ou "Elipse E3 (64-bits) 6.8.148".

[Link] E3ProductVersionBuild
E3ProductVersionBuild()
Este método retorna o número de build da versão do componente onde é invocado. Por exemplo, se a versão do
componente é a 6.8.148, este método retorna o valor 148.

[Link] E3ProductVersionMajor
E3ProductVersionMajor()
Este método retorna o número principal da versão do componente onde é invocado. Por exemplo, se a versão do
componente é a 6.8.148, este método retorna o valor 6.

[Link] E3ProductVersionMinor
E3ProductVersionMinor()
Este método retorna o número secundário da versão do componente onde é invocado. Por exemplo, se a versão do
componente é a 6.8.148, este método retorna o valor 8.

[Link] GetBit
GetBit(Value, BitIndex)
Retorna o valor (verdadeiro ou falso) do bit de Value especificado em BitIndex. Este método retorna um erro caso o
parâmetro BitIndex esteja fora da faixa permitida (entre zero e 31). Este método está disponível tanto em Associações
quanto em scripts.

NOTA
Este método permite passar um valor de 32 bits sem sinal, no intervalo entre zero e [Link], no parâmetro
Value. Caso seja utilizado um valor de ponto flutuante, somente a parte inteira deste valor é utilizada.

[Link] GetComputerName
GetComputerName()
Retorna uma String contendo o nome do computador atual. Este método está disponível tanto em Associações
quanto em scripts.

[Link] 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.

[Link] 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.

Programando no Elipse E3 29
[Link] 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.

[Link] IIf
IIf(Condition, ExprTrue, ExprFalse)
Retorna a expressão contida em ExprTrue se a condição avaliada em Condition é verdadeira, e a expressão contida em
ExprFalse se a condição avaliada é falsa. Este método está disponível tanto em Associações quanto em scripts.

NOTA
Este método não propaga a qualidade nem a estampa de tempo dos valores. Se uma Associação contém a
expressão IIf([Link] = 0, [Link], [Link]), o resultado é o valor de Tag2 ou Tag3, porém com
qualidade Boa (192) e estampa de tempo atual. Para que estas informações sejam preservadas, é necessário
especificar somente o objeto, como por exemplo IIf([Link] = 0, Tag2, Tag3).

[Link] LongToDword
LongToDword(Value)
Converte um valor de 32 bits com sinal, no intervalo entre -[Link] e [Link], passado no parâmetro Value
para um valor de 32 bits sem sinal, no intervalo entre zero e [Link], no mesmo padrão de bits. Se o valor
estiver entre zero e [Link], o valor é retornado sem mudanças.

NOTA
Caso o valor passado no parâmetro Value seja um valor de ponto flutuante, somente a parte inteira deste valor é
utilizada.

[Link] MsgBoxEx
MsgBoxEx(prompt, [buttons], [title], [PosX], [PosY])
Este método permite mostrar uma caixa de diálogo padrão do Windows e especificar a posição na tela. Os
parâmetros disponíveis neste método são os seguintes:
· prompt: Texto a ser mostrado na caixa de diálogo. O tamanho máximo deste texto é de aproximadamente 1024
caracteres, dependendo da largura dos caracteres usados. Para inserir quebras de linha no texto, separe as linhas
usando a função Chr do VBScript com os valores 10 (avanço de linha), 13 (retorno de carro) ou uma combinação
destes valores entre cada linha
· buttons: Uma expressão numérica opcional que representa a soma dos valores especificando a quantidade e o
tipo dos botões mostrados, o estilo, o botão padrão e se a caixa de diálogo é modal ou não. O valor padrão
deste parâmetro é 0 (zero), ou seja, mostra apenas o botão OK. Consulte a tabela a seguir para mais informações
sobre este parâmetro
· title: Texto opcional mostrado na barra de título da caixa de diálogo. Se este parâmetro é omitido, a caixa de
diálogo não mostra nenhum título
· PosX: Indica a posição, em pixels, da caixa de diálogo em relação à margem esquerda da janela. Caso este
parâmetro seja omitido, a respectiva coordenada da caixa de diálogo é centralizada na janela
· PosY: Indica a posição, em pixels, da caixa de diálogo em relação à margem superior da janela. Caso este
parâmetro seja omitido, a respectiva coordenada da caixa de diálogo é centralizada na janela

NOTA
Caso os valores indicados nos parâmetros PosX e PosY posicionem a caixa de diálogo fora da área visível da janela,
estes valores são ajustados automaticamente para garantir que a caixa de diálogo esteja visível.

Os valores possíveis para o parâmetro buttons estão descritos nas tabelas a seguir.

30 Programando no Elipse E3
 Valores possíveis para tipos de botões
VALOR DESCRIÇÃO CONSTANTE NO VBSCRIPT
0 Mostra apenas o botão OK vbOKOnly

1 Mostra os botões OK e Cancelar vbOKCancel

(Cancel)

2 Mostra os botões Abortar (Abort), vbAbortRetryIgnore

Repetir (Retry) e Ignorar (Ignore)

3 Mostra os botões Sim (Yes), Não vbYesNoCancel

(No) e Cancelar (Cancel)

4 Mostra os botões Sim (Yes) e Não vbYesNo

(No)

5 Mostra os botões Repetir (Retry) e vbRetryCancel

Cancelar (Cancel)

Valores possíveis para estilos de ícones

VALOR DESCRIÇÃO CONSTANTE NO VBSCRIPT
16 Mostra um ícone indicando uma vbCritical
mensagem crítica

32 Mostra um ícone indicando uma vbQuestion

pergunta

48 Mostra um ícone indicando uma vbExclamation

afirmação

64 Mostra um ícone indicando uma vbInformation

informação

Valores possíveis para botões padrão

VALOR DESCRIÇÃO CONSTANTE NO VBSCRIPT
0 Indica que o primeiro botão é o vbDefaultButton1
padrão de retorno

256 Indica que o segundo botão é o vbDefaultButton2

padrão de retorno

512 Indica que o terceiro botão é o vbDefaultButton3

padrão de retorno

768 Indica que o quarto botão é o vbDefaultButton4

padrão de retorno

Valores possíveis para tipos de janelas modais

VALOR DESCRIÇÃO CONSTANTE NO VBSCRIPT
0 Indica que o usuário deve responder vbApplicationModal
esta caixa de diálogo antes de
continuar trabalhando na aplicação

4096 Indica que todas as aplicações estão vbSystemModal

suspensas até que o usuário
responda esta caixa de diálogo

Este método retorna um valor numérico que representa o botão clicado na caixa de diálogo, conforme a tabela a
seguir.

Programando no Elipse E3 31
 Valores de retorno do método MsgBoxEx
VALOR BOTÃO CONSTANTE NO VBSCRIPT
1 OK vbOK

2 Cancelar (Cancel) vbCancel

3 Abortar (Abort) vbAbort

4 Repetir (Retry) vbRetry

5 Ignorar (Ignore) vbIgnore

6 Sim (Yes) vbYes

7 Não (No) vbNo

[Link] 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 ou 3: Constante.

[Link] 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 ou 3: Boa.

[Link] 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:
· 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
· 6: Subnormal

[Link] 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.

32 Programando no Elipse E3
[Link] 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.

[Link] 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.

[Link] OPCIsUncertain
OPCIsUncertain(Quality)
Retorna verdadeiro se a Qualidade OPC é Incerta, ou falso caso contrário. Este método está disponível tanto em
Associações quanto em scripts.

[Link] 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, consulte o método OPCGetSubStatus para os valores
possíveis). Se este parâmetro é omitido, assume o valor 0 (zero)
· Limit: Especifica o limite do valor. Se este parâmetro é omitido, assume o valor 0 (zero)
· 0: Livre
· 1: Baixo
· 2: Alto
· 3: Constante
· Vendor: Valor específico do fabricante (entre 0 e 255). Se este parâmetro é omitido, assume o valor 0 (zero)

[Link] 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 ou
3: Constante.

[Link] OPCSetQuality
OPCSetQuality(Quality, QualityFlag)
Modifica a informação de Qualidade 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 QualityFlag são 0: Ruim, 1:
Incerta, 2: Não utilizada ou 3: Boa.

[Link] 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

Programando no Elipse E3 33
 · 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
· 6: Subnormal

[Link] 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.

[Link] 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 zero e 31). Este método está disponível tanto em
Associações quanto em scripts.

NOTA
Este método permite passar um valor de 32 bits sem sinal, no intervalo entre zero e [Link], no parâmetro
Value, mas o valor de retorno é sempre um valor de 32 bits com sinal, no intervalo entre -[Link] e
[Link]. Caso seja utilizado um valor de ponto flutuante, somente a parte inteira deste valor é utilizada.

[Link] SourceTypeName
SourceTypeName(SourceType)
Retorna uma String com a descrição da Fonte de Medida ativa, ou seja, a propriedade ActiveSource dos objetos
Medida Analógica e Medida Discreta do Elipse Power e do Elipse Water. Este método está disponível tanto em
Associações quanto em scripts. Os valores possíveis para o parâmetro SourceType são:
· -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
· 105: Autorrecuperação

34 Programando no Elipse E3
 · 106: Leitor Externo

NOTA
Caso o valor passado no parâmetro SourceType não esteja entre os valores possíveis, este método retorna a String
"???".

[Link] XQuery
XQuery(ContextObject, [strQuery], [pVarOutError])
Este método retorna o resultado de uma Consulta Hierarquia do Aplicativo como uma String no formato XML. O
parâmetro ContextObject corresponde ao objeto de início desta Consulta. O parâmetro strQuery corresponde ao script
a ser utilizado na Consulta. O parâmetro opcional de saída pVarOutError contém uma String detalhando o resultado
da execução deste método.

2.8 Eventos, Métodos e Propriedades Gerais dos Objetos

Esta seção contém informações sobre os eventos, métodos e propriedades gerais dos objetos.

2.8.1 Eventos
Eventos são ocorrências relacionadas a um objeto que permitem disparar ações programadas. Existem, basicamente,
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 pode ser 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 ou 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.

[Link] Variáveis de Evento

Variáveis de Evento são criadas quando um evento inicia. Para serem utilizadas, devem ser associadas a parâmetros
na chamada do script do evento. O exemplo a seguir é a chamada de um procedimento associado ao evento
KeyDown de AlgumObjeto.
Sub AlgumObjeto_KeyDown(KeyCode, Shift)

Note que a chamada contém as variáveis KeyCode e Shift. O Elipse E3 atribui valores a estas variáveis automaticamente
no momento da ocorrência do evento. Neste caso, KeyCode recebe o código da tecla pressionada e Shift recebe
Verdadeiro ou Falso, conforme a tecla SHIFT esteja pressionada ou não.

[Link] OnStartRunning
OnStartRunning()
Ocorre tão logo um objeto seja iniciado. No exemplo a seguir, Meses é um Tag Interno e utiliza este evento para
inicializar o vetor.
Sub Meses_OnStartRunning()
Value = Array("Janeiro", "Fevereiro", "Março", "Abril",_
"Maio", "Junho", "Julho", "Agosto", "Setembro", "Outubro",_
"Novembro", "Dezembro")
End Sub

NOTA
Para acessar este array, é necessário copiar a propriedade Value para uma variável local.

[Link] OnStopRunning
OnStopRunning()
Ocorre quando termina a execução de uma instância de um objeto. Utilize este evento para realizar operações de
finalização para um objeto. O script a seguir contém um exemplo de uso deste evento.
Sub TagInterno1_OnStopRunning()
' Quando finaliza o objeto TagInterno1
' atribui False ao TagInterno2
Set tag2 = [Link]("Dados.TagInterno2")

Programando no Elipse E3 35
 [Link] = False
End Sub

2.8.2 Métodos
Esta seção contém informações sobre os métodos comuns aos objetos do Elipse E3. Cada tópico mostra o nome do
método com os respectivos parâmetros, na sintaxe correta, e um exemplo de utilização.

[Link] Chamadas de Métodos

Muitos métodos pré-definidos possuem parâmetros, que podem ou devem ser passados na chamada do método.
Para isto, o VBScript possui uma regra que deve ser seguida. Se um método é utilizado em uma atribuição, os
parâmetros devem estar entre parênteses, como neste exemplo de chamada do método GetObject.
obj = [Link]("dados.tag001")

Já se um método é chamado sozinho, deve-se retirar os parênteses, como neste exemplo de chamada do método
SetVariableValue.
[Link]("Consulta").SetVariableValue Valor, 12

Os parênteses usados nas citações de métodos neste documento servem apenas como indicativo para diferenciá-los
das propriedades. Nos scripts, deve-se seguir esta mesma regra.

[Link] Activate
Activate()
Ativa um objeto que está inativo no momento. O script a seguir contém um exemplo de uso deste método.
Sub CommandButton1_Click()
Dim obj, tag
Set obj = [Link]("Dados")
' Cria um novo objeto e o desativa (False)
Set tag = [Link]("DemoTag", False)
' Inicializa os parâmetros do novo objeto
[Link] = "tag001"
[Link] = 3
' Ativa o objeto (coloca em execução)
[Link]()
End Sub

NOTA
Ativar um objeto usando este método configura a propriedade IsObjectActive deste objeto para Verdadeiro.

[Link] AddObject
AddObject(ClassName, [Activate], [ObjectName])
Este método 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 igual a
"DrawRect". O objeto criado está contido no objeto que chamou este método 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 é ativado, as Associações e
scripts são habilitados. Se o objeto é criado com o parâmetro Activate em Falso, mais tarde pode ser ativado pelo
método Activate. Se este parâmetro é omitido, o objeto é ativado após a criação. O valor configurado neste
parâmetro é usado para configurar a propriedade IsObjectActive do objeto criado.
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 este parâmetro é omitido, o novo objeto é nomeado a partir do nome da
classe definida no parâmetro ClassName. Consulte a propriedade geral Name para mais informações sobre os
caracteres permitidos nos nomes de objetos.
O objeto só é criado se é 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 do VBScript.

NOTA
Apenas objetos que possuem a opção Inserir no seu menu contextual podem acessar este método.

36 Programando no Elipse E3
[Link] 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, ou seja, 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

NOTA
Os nomes dos contextos estão sempre em inglês, e não diferenciam maiúsculas de minúsculas. Para verificar o
contexto a que um objeto pertence, abra sua Janela de Propriedades, selecione a aba Item e verifique os contextos
válidos no quadro Contextos. Caso um objeto defina mais de um contexto, os nomes são apresentados em ordem
alfabética, separados por vírgulas.

[Link] Deactivate
Deactivate()
Este método desativa um objeto criado ou previamente ativado pelo método Activate. Pode-se desativar um objeto
quando é necessário realizar uma configuração prévia, como por exemplo na inicialização de propriedades, ou
quando é necessário realizar testes nos quais o objeto não pode estar presente e ativo. O script a seguir contém um
exemplo de uso deste método.
Sub CommandButton1_Click()
Dim obj, novo
Set obj = [Link]("Dados")
Set novo = [Link]("DemoTag", True)
' Desativa o objeto
[Link]()
End Sub

NOTA
Desativar um objeto usando este método configura a propriedade IsObjectActive deste objeto para Falso.

[Link] 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 a operação de apagar o objeto tenha
sido bem-sucedida, ou Falso caso o objeto filho não exista.
Para se apagar um objeto a partir de uma referência a um elemento, utilize este método no objeto pai. O script a
seguir contém um exemplo de uso deste método.
Sub CommandButton1_Click()
Set obj = [Link]("Dados")
If [Link]("Tag001") Then
MsgBox("Tag apagado com sucesso!")
Else
MsgBox("Falha ao apagar: o Tag não existe.")
End If
End Sub

NOTA
Apenas objetos que possuem a opção Inserir no seu menu contextual podem acessar este método.

[Link] GetChildObject
GetChildObject(ObjectPath)
Este método retorna uma referência para o objeto filho apontado pelo parâmetro ObjectPath. Com isto é possível
acessar todas as propriedades e métodos deste objeto, semelhante ao funcionamento do método GetObject. Este

Programando no Elipse E3 37
método falha se o caminho apontado por ObjectPath contiver uma propriedade ou método ao final. O caminho
apontado pelo objeto filho não é um caminho desde a raiz (o arquivo .prj) e sim um caminho sempre a partir do
objeto onde o método é chamado.

NOTA
Este método NÃO existe no objeto Application do Servidor e nem nas Pastas de Aplicativo, porém existe no objeto
Application do Viewer e é acessível mesmo em um Elipse E3 Viewer em modo Somente Leitura.

[Link] GetObject
GetObject(ObjectPath)
Este método 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 E3, facilita a
manipulação de objetos e deixa o código mais inteligível. O script a seguir contém um exemplo de uso deste método.
Sub CommandButton1_Click()
' Atribui o valor 20 à propriedade Value do objeto
' TagInterno1 que está em Dados.
Set tag = [Link]("Dados.TagInterno1")
[Link] = 20
End Sub

[Link] Item
Item(ItemId)
Retorna a referência para o objeto filho ItemId do objeto que chamou este método. Este método pode buscar um
objeto tanto pelo nome quanto pelo índice, um inteiro entre 1 (um) e o valor especificado na propriedade Count. Se o
índice ou o nome especificado é válido, este método retorna a referência ao objeto. Caso contrário, o método retorna
um erro de "Parâmetro Inválido". O script a seguir contém um exemplo de uso deste método.
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.
[Link] = RGB(255, 0, 0)
End Sub

[Link] RunEvent
RunEvent(EventName, [Arguments])
Executa o script ou scripts associados ao evento indicado pelo parâmetro EventName, que deve ser uma String. O
parâmetro Arguments é opcional e deve ser usado nos casos em que o evento necessite de argumentos. Estes
argumentos devem estar separados por vírgulas. Este método falha caso o evento indicado não tenha nenhum script
a ser executado.

[Link] RunProcedure
RunProcedure(ProcedureName, [Arguments])
Executa o script ou scripts associados ao procedimento (procedure) ou função (function) indicado pelo parâmetro
ProcedureName, que deve ser uma String. O parâmetro Arguments é opcional e deve ser usado nos casos em que o
procedimento ou função necessitem de argumentos. Estes argumentos devem estar separados por vírgulas. Este
método falha caso o procedimento ou função indicados não tenham nenhum script a ser executado. Este método
retorna um valor nos casos em que a função indicada pelo parâmetro ProcedureName também retorne um valor.

[Link] 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. O script a seguir contém um exemplo de uso deste método.
Sub CommandButton1_Click()
Set area = [Link]("ConfigAlarms")._
AddObject("Area", True)

38 Programando no Elipse E3
 [Link]("ConfigAlarms").Save()
End Sub

NOTA
As modificações executadas em tempo de execução e salvas no objeto só são visíveis no Elipse E3 Studio após a
atualização do projeto. Para isto, clique com o botão direito do mouse no nome do projeto e selecione a opção
Atualizar.

2.8.3 Propriedades
Todo objeto possui Propriedades, que servem para guardar informações a respeito das características daquele
objeto. Por exemplo, um objeto do tipo Retângulo possui a propriedade Name, que contém o nome, e as
propriedades Width e Height, que guardam a largura e altura, respectivamente, entre outras propriedades.
Neste capítulo são listadas todas as propriedades gerais dos objetos do Elipse E3. Cada tópico traz o nome da
propriedade, a descrição e, quando aplicável, um exemplo de uso. As propriedades são identificadas por um ícone
que indica o tipo de dados suportado no conteúdo. Os tipos de dados disponíveis estão descritos na tabela a seguir.
Tipos de dados disponíveis
TIPO DE DADOS DESCRIÇÃO
Booleano Representa os valores Verdadeiro (True) ou Falso (False)

Coleção Representa uma coleção de objetos

Item de Coleção Representa um item de uma coleção de objetos

Cor Representa uma cor no formato RGB

Data e Hora Representa uma data no calendário Gregoriano,

iniciando em 1899

Enumeração Representa um conjunto determinado de valores

Fonte Representa uma fonte a ser aplicada a um texto

GUID Representa um valor GUID (Globally Unique Identifier ou

Identificador Único Global)

Propriedade Indexada Representa uma propriedade cujos valores podem ser

acessados através de um índice

Link Representa uma associação entre objetos

Número Representa um valor inteiro ou Double, positivo ou

negativo, a ser definido pela propriedade

Figura Representa uma imagem no formato BMP, EMF, GIF,

ICO, JPEG, PNG, TIFF ou WMF

Texto Representa um texto

Variant Representa um valor variável, que pode assumir vários

formatos

Algumas propriedades podem propagar seus valores à mesma propriedade nos objetos filhos. Neste caso, são
chamadas de propriedades propagáveis. Pode-se, no entanto, forçar a propriedade do objeto filho a se comportar
de modo diferente.

NOTA
O Elipse E3 utiliza para definição de coordenadas e espessura o sistema Himetric. Neste sistema, cada unidade
lógica equivale a um milésimo de centímetro, ou seja, cada 1000 unidades equivalem a um centímetro. Assim, este é
o padrão adotado na descrição das propriedades do Elipse E3, quando aplicável.

Programando no Elipse E3 39
[Link] Application
Esta propriedade retorna o objeto de aplicação relacionado ao contexto atual do objeto. Esta propriedade é
somente de leitura. Com o objeto Aplicação é possível, por exemplo, buscar outros objetos presentes no aplicativo. O
script a seguir contém um exemplo de uso desta propriedade.
Sub Tela1_Click()
' Quando clica na tela, atribui um valor e abre um MessageBox
set obj = [Link]("Dados.TagInterno1")
[Link] = 100
MsgBox "Valor do TagInterno1: " & [Link]
End Sub

[Link] Count
Retorna o número de objetos filhos, ou itens, que um objeto possui. Esta propriedade funciona em conjunto com o
método Item. Se o objeto não possuir filhos, o valor retornado é 0 (zero). Esta propriedade é somente de leitura. O
script a seguir contém um exemplo de uso desta propriedade.
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
[Link] = RGB(255, 0, 0)
Next
End Sub

[Link] DocString
Texto livre que tem por objetivo possibilitar a documentação das funcionalidades ou características do objeto pelos
programadores do projeto. O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Docstring = "Este botão ativa o condensador do sistema."
MsgBox Docstring
End Sub

[Link] ExposeToOpc
Indica se um objeto e os respectivos filhos devem ser expostos no Servidor OPC UA. Os valores possíveis para esta
propriedade são 0 - eeUseParentConfig: Usa a configuração desta propriedade no respectivo objeto pai (padrão), 1
- eeExpose: Expõe este objeto, independente da configuração no respectivo objeto pai ou 2 - eeDontExpose: Não
expõe este objeto, independente da configuração do respectivo objeto pai.

NOTA
Os objetos Servidor de Alarmes, Configuração de Alarmes, Banco de Dados e os objetos do Viewer não podem ser
expostos no Servidor OPC UA.

[Link] IsObjectActive
Esta propriedade indica se um objeto está ativado. Em tempo de execução, todos os objetos definidos em um
projeto retornam Verdadeiro nesta propriedade até que seja usado o método Deactivate no objeto ou em um de
seus objetos pai. Objetos criados em tempo de execução usando o método AddObject configuram esta propriedade
de acordo com o parâmetro Activate deste método. Para o caso de objetos pré-ativados em Hot-Standby, ou seja, os
objetos configurados na opção Serviços pré-ativados no servidor reserva da aba Opções na janela de configuração
do Domínio do E3 Admin, têm esta propriedade configurada em Falso até que o servidor reserva assuma a execução
do Domínio.

[Link] Links
Retorna um objeto que é uma coleção das conexões (ou Associações) de um objeto qualquer do Elipse E3. Esta
propriedade é somente de leitura. Consulte o tópico Coleção de Associações para mais informações sobre a coleção
de objetos retornados por esta propriedade.

40 Programando no Elipse E3
[Link] Name
Identifica um objeto na aplicação. Esta propriedade não pode ser alterada com o objeto ativo. Ao alterar esta
propriedade, é necessário modificar todas as propriedades ou scripts que utilizam este objeto. Não é aconselhável a
alteração desta propriedade em tempo de execução.
Os caracteres a seguir são reservados e automaticamente substituídos pelo caractere de sublinhado (_):
· Qualquer caractere com código ASCII menor que 32 e o caractere com código ASCII 127 (DEL)
· Colchetes ([ e ]), quando usados em expressões
· Barra invertida (\), que é usada em caminhos de recursos
· Dois pontos (:), que são usados em caminhos de Domínios Remotos e bancos de dados
· Aspas duplas ("), que são usadas para delimitar Strings em expressões
· Ponto de interrogação (?), que é usado para delimitar opções na propriedade SplitLink e nos métodos
ShowScreen e OpenScreen do Divisor, além do evento OnPreShow da Tela

Os demais caracteres podem ser utilizados, mas devem ser delimitados por colchetes quando utilizados em um
caminho nos seguintes casos:
· Contenha qualquer caractere que não seja uma letra (a-z | A-Z) quando usado como primeiro caractere do
caminho
· Contenha qualquer caractere que não seja uma letra (a-z | A-Z), um número (0-9) ou um sublinhado (_) quando
usado após o primeiro caractere do caminho

[Link] ObjectEvents
Retorna um objeto que é uma coleção de Eventos, tanto pré-definidos quanto de usuário, de um objeto qualquer
do Elipse E3. Esta propriedade é somente de leitura. Consulte o tópico Coleção de Eventos para mais informações
sobre a coleção de objetos retornados por esta propriedade.

[Link] Parent
Retorna o objeto pai deste objeto. Sendo assim, se um objeto está inserido na Tela, esta propriedade retorna o
valor "Tela". Da mesma forma, se um Tag Interno está inserido diretamente abaixo de um Servidor de Dados, esta
propriedade deste Tag Interno aponta para o Servidor de Dados. Esta propriedade é somente de leitura. O script a
seguir contém um exemplo de uso desta propriedade.
Sub Retangulo1_Click()
' Ao clicar no Retangulo1,
' troca a cor do Retangulo2
[Link]("Retangulo2").ForegroundColor = RGB(255, 0, 0)
End Sub

[Link] 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 é requisitado, por isto não é recomendado criar Associações para esta
propriedade. Esta propriedade é somente de leitura.

[Link] PathName
Identifica o caminho de um objeto na aplicação. Esta propriedade é somente de leitura. O script a seguir contém um
exemplo de uso desta propriedade.
Sub CommandButton9_Click()
MsgBox "O caminho da Tela é " & ([Link])
End Sub

[Link] PathVolume
Retorna uma String contendo o nome do arquivo .prj ou .lib que contém o objeto. No Elipse E3 Studio, esta
propriedade retorna o caminho completo do projeto ou biblioteca (c:\folder\folder\[Link]). Em tempo de
execução, os objetos que executam no Elipse E3 Viewer retornam sempre uma String vazia. Já os que executam no
servidor retornam o caminho relativo do projeto ou biblioteca, conforme esteja armazenado no Domínio ([Link]).
Este valor é determinado apenas no momento em que é requisitado, por isto não é recomendado criar Associações
para esta propriedade. Esta propriedade é somente de leitura.

Programando no Elipse E3 41
2.8.4 Coleção de Associações
Esta seção contém informações sobre os métodos e propriedades comuns à coleção de Associações (Links) de um
objeto qualquer do Elipse E3, retornada pela propriedade Links.

[Link] Métodos Comuns

Esta seção contém informações sobre os métodos comuns à coleção de Associações (Links) retornada pela
propriedade Links.

[Link].1 CreateLink
CreateLink(Property, Source, [BindType])
Este método permite criar uma Associação com uma propriedade de um objeto. Em caso de sucesso, este método
retorna o objeto criado. Caso contrário, ocorre um erro de script e o método retorna Nothing. Este método possui
os parâmetros Property, que especifica o nome da propriedade para a qual é criada a Associação, Source, que
especifica o nome do objeto de origem da Associação, e BindType, que é opcional e especifica o tipo de Associação a
ser criada. Se este parâmetro é omitido, cria uma Associação Simples.

NOTA
Nem todas as propriedades existentes em um objeto permitem a criação de Associações. Para verificar quais as
propriedades permitem este recurso, acesse a aba Associações da Janela de Propriedades do objeto. Se a
propriedade é inválida para uma Associação, não existir ou já possuir uma Associação, ocorre um erro de script.

Opções disponíveis para o parâmetro BindType

OPÇÃO DESCRIÇÃO
0 - Associação Simples Na Associação Simples, o valor da origem é copiado
para a propriedade toda vez que é modificado

1 - Associação Bidirecional Na Associação Bidirecional ocorre o mesmo que na

Simples, mas caso haja uma variação na propriedade, o
valor é copiado para a origem, gerando assim uma
Associação de duas direções

2 - Associação Analógica A Associação Analógica estabelece uma escala de

conversões entre a variável de origem e a propriedade

3 - Associação Digital Na Associação Digital são especificados valores fixos ou

alternantes para a propriedade, que são atribuídos de
acordo com a fonte ser verdadeira ou falsa

4 - Associação por Tabela Na Associação por Tabela pode-se estabelecer

condições entre a variável, os valores e o destino. Na
tabela são especificados os valores mínimos e máximos
e demais configurações

5 - Associação Reversa A Associação Reversa é uma Associação unidirecional da

propriedade para a fonte

6 - Associação Múltipla A Associação Múltipla é semelhante a uma Associação

por Tabela, exceto que cada linha da Associação permite
buscar seu valor de uma fonte diferente

No exemplo a seguir, clicar no Botão de Comando cria uma Associação Bidirecional para o valor de um Tag Interno
no objeto Texto1, ou seja, configura o parâmetro BindType para o valor 1 (um).
Sub CommandButton1_Click()
On Error Resume Next
Dim bndType, bndValue
bndType = 1 'Associação Bidirecional
Set bndValue = [Link]("Texto1").[Link]("Value")
If bndValue Is Nothing Then
MsgBox "Criando uma Associação Bidirecional"
Set bndValue = [Link]("Texto1").[Link]("Value", "[Link]",
bndType)

42 Programando no Elipse E3
 Else
MsgBox "Texto1 já tem uma Associação para " & [Link]
End If
End Sub

[Link].2 Item
Item(ItemId)
Este método retorna um objeto Associação de uma determinada propriedade de um objeto. Se é um texto, o
parâmetro ItemId especifica o nome da propriedade cuja Associação deseja-se acessar. A Associação também pode
ser acessada por um índice numérico. Este índice deve estar entre 1 (um) e Count. Caso não exista Associação com a
propriedade, ou o índice seja inválido, ocorre um erro de script. Assim como as demais coleções, a coleção de
Associações permite o uso da declaração For Each do VBScript. O script a seguir contém um exemplo de uso deste
método.
Sub Texto1_Click()
For Each Link In Links
MsgBox "Origem do link: " & [Link]
Next
End Sub

[Link].3 RemoveLink
RemoveLink(Property)
Este método remove uma Associação com a propriedade especificada por Property, caso exista. Caso não exista
Associação com a propriedade especificada, este método não tem efeito. O script a seguir contém um exemplo de
uso deste método.
Sub CommandButton2_Click()
On Error Resume Next
Dim Bind
Set Bind = [Link]("ScrollBar1").[Link]("Value")
If Bind Is Nothing Then
' Se a conexão não existe
MsgBox "ScrollBar1 não está conectado."
Else
MsgBox "ScrollBar1 está ligado à " & [Link] & "."
MsgBox "Removendo o link."
[Link]("ScrollBar1").[Link]("Value")
End If
End Sub

[Link] Propriedades Comuns

Esta seção contém informações sobre as propriedades comuns à coleção de Associações (Links) retornada pela
propriedade Links.

[Link].1 Count
Retorna o número de objetos filhos, ou itens, de uma coleção de Associações. Esta propriedade trabalha em
conjunto com o método Item. Se a coleção não possui objetos filhos, o valor retornado é 0 (zero). Esta propriedade é
somente de leitura.

[Link] 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:
· Analógica
· Bidirecional
· Digital
· Múltipla
· Por Tabela
· Reversa
· Simples

Programando no Elipse E3 43
[Link].1 Propriedades Comuns
Esta seção contém informações sobre as propriedades comuns aos objetos contidos na coleção de Associações
retornada pela propriedade Links.

[Link].1.1 Property
Especifica o nome da propriedade que está conectada. Ao ser modificada, permite deslocar a Associação para
outra propriedade do mesmo objeto. O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Dim bind
Set bind = [Link]("TableBind").[Link](1)
[Link] = "Caption"
End Sub

[Link].1.2 Source
Especifica a fonte da Associação, que pode ser o nome de outro objeto da aplicação ou uma expressão mais
complexa, acessando vários objetos. O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Dim bind
Set bind = [Link]("TableBind").[Link](1)
[Link] = "[Link]"
End Sub

[Link].1.3 Type
Esta propriedade é somente de leitura e informa o tipo de Associaçã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 - bsSimple Associação Simples

1 - bsSimpleBiDir Associação Bidirecional

2 - bsAnalog Associação Analógica

3 - bsAnimation Associação Digital

4 - bsTable Associação por Tabela

5 - bsReverse Associação Reversa

6 - bsMultiSource Associação Múltipla

[Link].2 Associação Analógica

Esta seção contém informações sobre as propriedades do objeto Associação Analógica (AnalogBind). Este objeto não
possui eventos nem métodos associados.

[Link].2.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Associação Analógica (AnalogBind).
DstHiValue
Esta propriedade especifica o valor máximo atingido na propriedade. O script a seguir contém um exemplo de uso
desta propriedade.
Sub DstHiValue_ValueChange()
On Error Resume Next
Dim Bind
Set Bind = [Link]("ScrollBar1").[Link]("Value")
[Link]("ScrollBar1").Max = Value
If Bind Is Nothing Then
MsgBox "ScrollBar1 não tem associação."
Else
MsgBox "ScrollBar1 está associado a '" & [Link] & "'"
MsgBox "Mudando DstHiValue de " &_
[Link] & " para " & Value
[Link] = Value

44 Programando no Elipse E3
 End If
End Sub
DstLoValue
Esta propriedade especifica o valor mínimo atingido na propriedade. O script a seguir contém um exemplo de uso
desta propriedade.
Sub DstLoValue_ValueChange()
On Error Resume Next
Dim Bind
Set Bind = [Link]("ScrollBar1").[Link]("Value")
[Link]("ScrollBar1").Min = Value
If Bind Is Nothing Then
MsgBox "ScrollBar1 não tem associação."
Else
MsgBox "ScrollBar1 está associado a '" & [Link] & "'"
MsgBox "Mudando DstLoValue de " &_
[Link] & " para " & Value
[Link] = Value
End If
End Sub
SrcHiValue
Esta propriedade especifica o valor máximo atingido na fonte. O script a seguir contém um exemplo de uso desta
propriedade.
Sub SrcHiValue_ValueChange()
On Error Resume Next
Dim Bind
Set Bind = [Link]("ScrollBar1").[Link]("Value")
[Link]("ScrollBar2").Max = Value
If Bind Is Nothing Then
MsgBox "ScrollBar1 não tem associado."
Else
MsgBox "ScrollBar1 está associado a '" & [Link] & "'"
MsgBox "Mudando SrcHiValue de " &_
[Link] & " para " & Value
[Link] = Value
End If
End Sub
SrcLoValue
Esta propriedade especifica o valor mínimo atingido na fonte. O script a seguir contém um exemplo de uso desta
propriedade.
Sub SrcLoValue_ValueChange()
On Error Resume Next
Dim Bind
Set Bind = [Link]("ScrollBar1").[Link]("Value")
[Link]("ScrollBar2").Min = Value
If Bind Is Nothing Then
MsgBox "ScrollBar1 não tem associado."
Else
MsgBox "ScrollBar1 está associado a '" & [Link] & "'"
MsgBox "Mudando SrcLoValue de " &_
[Link] & " para " & Value
[Link] = Value
End If
End Sub

NOTA
Caso os valores especificados para as propriedades SrcHiValue e SrcLoValue sejam iguais, não é possível executar
a escala, e a Associação funciona como se fosse uma Associação Simples.

[Link].3 Associação Bidirecional

Esta seção contém informações sobre as propriedades do objeto Associação Bidirecional (AgSimple). Este objeto não
possui eventos nem métodos associados.

[Link].3.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Associação Bidirecional (AgSimple).

Programando no Elipse E3 45
BiDirectional
Esta propriedade retorna Verdadeiro se a Associação é Bidirecional e Falso se a Associação é Reversa ou Simples.

[Link].4 Associação Digital

Esta seção contém informações sobre as propriedades do objeto Associação Digital (AnimationBind). Este objeto não
possui eventos nem métodos associados.

[Link].4.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Associação Digital (AnimationBind).
BlinkOff
Quando esta propriedade estiver configurada para Verdadeiro, a propriedade conectada alterna periodicamente
entre os valores das propriedades OffValue e BlinkOffValue, caso a fonte retorne Falso. O script a seguir contém um
exemplo de uso desta propriedade.
Sub BlinkOff_Change()
On Error Resume Next
Dim Bind
Set Bind = [Link]("Retangulo1")._
[Link]("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 não tem associação."
Else
MsgBox "Retangulo1 está associado a '" & [Link] & "'"
MsgBox "Mudando BlinkOff de " & _
[Link] & " para " & Value
[Link] = Value
End If
End Sub
BlinkOffValue
Esta propriedade especifica o valor alternativo a ser assumido periodicamente pela propriedade quando a
expressão da fonte resultar em Falso e a propriedade BlinkOff estiver configurada em Verdadeiro. O script a seguir
contém um exemplo de uso desta propriedade.
Sub BlinkOffValue_Click()
On Error Resume Next
Dim Value
If Application.ShowPickColor_
(Value, ForegroundColor, 400, 300) Then
Dim Bind
Set Bind = [Link]("Retangulo1").Links._
Item("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 não tem associação."
Else
MsgBox "Retangulo1 está associado a '"& [Link] & "'"
MsgBox "Mudando BlinkOffValue de " &_
[Link] & " para " & Value
[Link] = Value
End If
ForegroundColor = Value
End If
End Sub
BlinkOn
Quando esta propriedade estiver configurada para Verdadeiro, a propriedade conectada alterna periodicamente
entre os valores das propriedades OnValue e BlinkOnValue, caso a fonte retorne Verdadeiro. O script a seguir
contém um exemplo de uso desta propriedade.
Sub BlinkOn_Change()
On Error Resume Next
Dim Bind
Set Bind =_
[Link]("Retangulo1").[Link]("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 não tem associação."
Else
MsgBox "Retangulo1 está associado a '" & [Link] & "'"
MsgBox "Mudando BlinkOn de " & Bind._
BlinkOn & " para " & Value
[Link] = Value
46 Programando no Elipse E3
 End If
End Sub
BlinkOnValue
Esta propriedade especifica o valor alternativo a ser assumido periodicamente pela propriedade quando a
expressão da fonte resultar em Verdadeiro e a propriedade BlinkOn estiver configurada para Verdadeiro. O script a
seguir contém um exemplo de uso desta propriedade.
Sub BlinkOnValue_Click()
On Error Resume Next
Dim Value
If Application.ShowPickColor_
(Value, ForegroundColor, 400, 300) Then
Dim Bind
Set Bind = [Link]("Retangulo1").Links._
Item("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 não tem associação."
Else
MsgBox "Retangulo1 está associado a '"& [Link] & "'"
MsgBox "Mudando BlinkOnValue de " &_
[Link] & " para " & Value
[Link] = Value
End If
ForegroundColor = Value
End If
End Sub
OffValue
Esta propriedade especifica o valor assumido pela propriedade quando a expressão da fonte resultar em Falso. O
script a seguir contém um exemplo de uso desta propriedade.
Sub OffValue_Click()
On Error Resume Next
Dim Value
If Application.ShowPickColor_
(Value, ForegroundColor, 400, 300) Then
Dim Bind
Set Bind = [Link]("Retangulo1").Links._
Item("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 não tem associação."
Else
MsgBox "Retangulo1 está associado a '"& [Link] & "'"
MsgBox "Mudando OffValue de " &_
[Link] & " para " & Value
[Link] = Value
End If
ForegroundColor = Value
End If
End Sub
OnValue
Esta propriedade especifica o valor assumido pela propriedade quando a expressão da fonte resultar em
Verdadeiro. O script a seguir contém um exemplo de uso desta propriedade.
Sub OnValue_Click()
On Error Resume Next
Dim Value
If Application.ShowPickColor_
(Value, ForegroundColor, 400, 300) Then
Dim Bind
Set Bind = [Link]("Retangulo1").Links._
Item("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 não tem associação."
Else
MsgBox "Retangulo1 está associado a '"& [Link] & "'"
MsgBox "Mudando OnValue de " &_
[Link] & " para " & Value
[Link] = Value
End If
ForegroundColor = Value
End If
End Sub

Programando no Elipse E3 47
[Link].5 Associação Múltipla
Esta seção contém informações sobre os métodos e propriedades do objeto Associação Múltipla (MultiSourceBind).
Este objeto não possui eventos associados.

[Link].5.1 Métodos
Esta seção contém informações sobre os métodos do objeto Associação Múltipla (MultiSourceBind).
InsertRow
InsertRow([InsertAtRow])
Insere uma nova Linha na tabela de Associações Múltiplas na posição indicada pelo parâmetro InsertAtRow. Este
parâmetro é opcional e, se omitido, insere a nova Linha ao final da tabela de Associações Múltiplas, o que equivale a
usar o parâmetro InsertAtRow com o valor -1 (menos um). Se o valor informado em InsertAtRow não é omitido e é
diferente de -1 (menos um), este valor deve estar entre 1 (um) e Count e a nova Linha criada desloca as Linhas de
índice maior ou igual para a direção ascendente dos índices.
Item
Item(ItemId)
Retorna uma referência para o objeto Linha da Conexão Múltipla, indicado por ItemId.
RemoveRow
RemoveRow(Row)
Remove a Linha no índice indicado pelo parâmetro Row.

[Link].5.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Associação Múltipla (MultiSourceBind).
AdviseAll
Esta propriedade mantém todas as Associações da tabela de Associações Múltiplas em modo Advise (ativas). O
valor padrão desta propriedade é Verdadeiro. Para aplicações criadas em versões anteriores, esta propriedade tem o
valor Falso, por compatibilidade.
Count
Esta propriedade retorna o número de Linhas da tabela de Associações Múltiplas. Esta propriedade é somente de
leitura.

[Link].5.3 Linha da Associação Múltipla

Esta seção contém informações sobre as propriedades do objeto Linha da Associação Múltipla (MultiSourceRow). Este
objeto não possui eventos nem métodos associados.
Propriedades
Esta seção contém informações sobre as propriedades do objeto Linha da Associação Múltipla (MultiSourceRow).
Max
Esta propriedade especifica o intervalo máximo para o valor da Associação indicada na propriedade Source.
Min
Esta propriedade especifica o intervalo mínimo para o valor da Associação indicada na propriedade Source.
Source
Esta propriedade especifica a fonte da Associação da Linha da Conexão Múltipla, que pode ser o nome de outro
objeto da aplicação ou uma expressão mais complexa, acessando vários objetos.

[Link].6 Associação por Tabela

Esta seção contém informações sobre os métodos e propriedades do objeto Associação por Tabela (TableBind). Este
objeto não possui eventos associados.

[Link].6.1 Métodos
Esta seção contém informações sobre os métodos do objeto Associação por Tabela (TableBind).

48 Programando no Elipse E3
InsertRow
InsertRow([InsertAtRow])
Insere uma nova Linha na tabela. O parâmetro InsertAtRow é 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 InsertAtRow igual a -1 (menos um). Quando informado e diferente de -1 (menos um), deve ser um valor entre 1
(um) 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

O script a seguir contém um exemplo de uso deste método.

Sub Retangulo1_Click()
On Error Resume Next
Dim Bind
Set Bind = _
[Link]("Retangulo1").[Link]("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 não tem nenhuma associação."
Else
Dim row
row = [Link]("SetPointRow").Value
MsgBox [Link]
If (row < 1 OR row > [Link]) Then
MsgBox "Número de linha inválido: " & row
Else
MsgBox "Acrescentando uma linha em: " & row
[Link](row)
If row = -1 Then
row = [Link]
[Link](line) = _
[Link]("RectangleValue").ForegroundColor
[Link](line) = _
[Link]("RectangleBlinkValue").ForegroundColor
[Link](line) = [Link]("SetPointMax").Value
[Link](line) = [Link]("SetPointMin").Value
[Link](line) = _
[Link]("CheckBoxBlink").Value
End If
End If
End If
End Sub
Item
Item(ItemId)
Retorna uma referência para o objeto Linha da Conexão por Tabela, indicado por ItemId.
RemoveRow
RemoveRow(Row)
Remove a Linha no índice especificado. O parâmetro Row determina a Linha da tabela a ser removida e deve estar
entre 1 (um) e Count. O script a seguir contém um exemplo de uso deste método.
Sub RemoveRow_Click()
On Error Resume Next
Dim Bind
Set Bind =_
[Link]("Retangulo1").[Link]("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 não tem associação!"
Else
MsgBox "Retangulo1 está ligado à '" & [Link] & "'"
Dim row
row = [Link]("Row").Value
MsgBox "Removendo a linha " & row
[Link] row

Programando no Elipse E3 49
 End If
End Sub

[Link].6.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Associação por Tabela (TableBind).
Count
Esta propriedade informa o número de linhas na tabela. Esta propriedade é somente de leitura.

[Link].6.3 Linha da Associação por Tabela

Esta seção contém informações sobre as propriedades do objeto Linha da Associação por Tabela (TableBindRow).
Este objeto não possui eventos nem métodos associados.
Propriedades
Esta seção contém informações sobre as propriedades do objeto Linha da Associação por Tabela (TableBindRow).
Blink
Esta propriedade determina que quando a fonte estiver no intervalo desta Linha, a propriedade alterna
periodicamente entre os valores especificados nas propriedades Value e BlinkValue. O script a seguir contém um
exemplo de uso desta propriedade.
Sub CheckBox1_Click()
[Link]("Retangulo1").[Link]("ForegroundColor")._
Item(1).Blink = Value
[Link]("Retangulo1").[Link]("ForegroundColor")._
Item(2).Blink = Value
End Sub
BlinkValue
Esta propriedade especifica o valor alternativo (para piscar) da propriedade a ser assumido quando a fonte estiver
no intervalo especificado na Linha e a propriedade Blink estiver configurada para Verdadeiro. O script a seguir
contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Dim Cor
' Escolhe uma cor
[Link] Cor, 0, 100, 100
[Link]("Retangulo1").[Link]("ForegroundColor")._
Item(1).BlinkValue = Cor
End Sub
Max
Esta propriedade especifica o valor máximo da fonte para uma Linha da Tabela.
Min
Esta propriedade especifica o valor mínimo da fonte para uma Linha da Tabela. O exemplo a seguir se aplica tanto
para a propriedade Max quanto para Min.
Sub CommandButton1_Click()
Set Bind = _
[Link]("Retangulo1").[Link]("ForegroundColor")
Set Linha1 = [Link](1)
[Link] = 0
[Link] = 20
Set Linha2 = [Link](2)
[Link] = 21
[Link] = 100
End Sub
Value
Esta propriedade especifica o valor da propriedade a ser assumido quando a fonte estiver no intervalo especificado
na Linha. O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Dim Cor
' Escolhe uma cor
[Link] Cor, 0, 100, 100
[Link]("Retangulo1").[Link]("ForegroundColor")._
Item(1).Value = Cor
End Sub

50 Programando no Elipse E3
[Link].7 Associação Reversa
Esta seção contém informações sobre as propriedades do objeto Associação Reversa (AgSimple). Este objeto não
possui eventos nem métodos associados.

[Link].7.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Associação Reversa (AgSimple).
Reverse
Esta propriedade retorna Verdadeiro se a Associação é Reversa e retorna Falso se a Associação é Bidirecional ou
Simples.

[Link].8 Associação Simples

O objeto Associação Simples (AgSimple) não tem eventos, métodos ou propriedades associadas.

2.8.5 Coleção de Eventos

Esta seção contém informações sobre os métodos e propriedades do objeto Coleção de Eventos (Events) retornado
pela propriedade ObjectEvents. Este objeto não possui eventos associados.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Eventos (Events) retornado pela propriedade
ObjectEvents.

[Link].1 AddUserEvent
AddUserEvent(Name, [Link], [Type], [ScanTime], [ChangeOnDisconnect])
Adiciona um Evento de Usuário na Coleção de Eventos e retorna este objeto. Os parâmetros deste método estão
descritos na tabela a seguir.
Parâmetros do método AddUserEvent
PARÂMETRO DESCRIÇÃO
Name Nome deste Evento de Usuário. Este parâmetro é
obrigatório

Link Expressão a ser avaliada neste Evento de Usuário. Este

parâmetro é opcional e, se omitido, assume o valor de
uma String vazia. Corresponde à propriedade Link do
objeto Evento de Usuário

Type Tipo de Evento de Usuário. Este parâmetro é opcional e,

se omitido, assume o valor 0 (zero). Corresponde à
propriedade Type do objeto Evento de Usuário

ScanTime Tempo, em milissegundos, de repetição deste Evento de

Usuário. Este parâmetro é opcional e, se omitido, assume
o valor 1000, ou seja, um segundo. Corresponde à
propriedade ScanTime do objeto Evento de Usuário

ChangeOnDisconnect Indica se a desconexão é tratada como mudança no

valor da expressão deste Evento de Usuário. Este
parâmetro é opcional e, se omitido, assume o valor 0
(zero), ou seja, Falso. Corresponde à propriedade
ChangeOnDisconnect do objeto Evento de Usuário

[Link].2 Item
Item(ItemId)
Este método retorna um objeto Evento ou Evento de Usuário da Coleção de Eventos de um objeto qualquer do Elipse
E3. Se este parâmetro é um texto, o parâmetro ItemId especifica o nome do objeto a acessar. O objeto também pode
ser acessado por um índice numérico. Este índice deve estar entre 1 (um) e Count. Caso o objeto não exista, ou o
índice seja inválido, ocorre um erro de script.

Programando no Elipse E3 51
[Link].3 RemoveUserEvent
RemoveUserEvent(Name)
Remove um Evento de Usuário, indicado pelo parâmetro Name, da Coleção de Eventos. Este método retorna erro em
caso de parâmetro inválido.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Eventos (Events) retornado pela
propriedade ObjectEvents.

[Link].1 Count
Retorna o número de objetos filhos, ou itens, de uma coleção de Eventos. Esta propriedade trabalha em conjunto
com o método Item. Se a coleção não possui objetos filhos, o valor retornado é 0 (zero). Esta propriedade é somente
de leitura.

[Link] Evento
Esta seção contém informações sobre os métodos e propriedades do objeto Evento (Event) da Coleção de Eventos.
Este objeto não possui eventos associados.

[Link].1 Métodos
Esta seção contém informações sobre os métodos do objeto Evento (Event) da Coleção de Eventos.

[Link].1.1 AddScript
AddScript(bstrCode)
Adiciona um Pick do tipo Executar Script a este Evento com o código especificado no parâmetro bstrCode. Este
parâmetro deve conter apenas o corpo do script, sem a linha inicial Sub e sem a linha final End Sub, e pode ser uma
String vazia.

[Link].1.2 RemoveAll
RemoveAll()
Remove todos os Picks do tipo Executar Script deste Evento. Este método não retorna erro caso não haja Picks neste
Evento.

[Link].2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Evento (Event) da Coleção de Eventos.

[Link].2.1 Name
Retorna o nome deste Evento na Coleção de Eventos. Esta propriedade é somente de leitura.

[Link] Evento de Usuário

Esta seção contém informações sobre os métodos e propriedades do objeto Evento de Usuário (UserEvent) da
Coleção de Eventos. Este objeto não possui eventos associados.

[Link].1 Métodos
Esta seção contém informações sobre os métodos do objeto Evento de Usuário (UserEvent) da Coleção de Eventos.

[Link].1.1 AddScript
AddScript(bstrCode)
Adiciona um script a este Evento de Usuário com o código especificado no parâmetro bstrCode. Este parâmetro deve
conter apenas o corpo do script, sem a linha inicial Sub e sem a linha final End Sub, e pode ser uma String vazia.

52 Programando no Elipse E3
[Link].1.2 RemoveAll

RemoveAll()
Remove todos os scripts deste Evento de Usuário. Este método não retorna erro caso não haja scripts neste Evento
de Usuário.

[Link].2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Evento de Usuário (UserEvent) da Coleção de
Eventos.

[Link].2.1 ChangeOnDisconnect
Indica se uma desconexão é tratada como uma alteração no valor da expressão indicada na propriedade Link. Esta
propriedade somente se aplica a Eventos de Usuário cuja propriedade Type seja igual a 2 (dois,
uetOnValueChanged). O valor padrão desta propriedade é Falso.

[Link].2.2 Link
Texto com a expressão avaliada no Evento de Usuário. O valor padrão desta propriedade é uma String vazia.

[Link].2.3 ScanTime
Tempo, em milissegundos, referente ao período de repetição deste Evento de Usuário. Esta propriedade somente
se aplica a Eventos de Usuário cuja propriedade Type seja igual a 1 (um, uetWhileTrue). O valor padrão desta
propriedade é 1000, ou um segundo.

[Link].2.4 Type
Indica o tipo de Evento de Usuário. Os valores possíveis para esta propriedade são 0 - uetOnEvent: o Evento de
Usuário dispara quando o valor da expressão muda de Falso para Verdadeiro (padrão), 1 - uetWhileTrue: o Evento
de Usuário dispara periodicamente enquanto o valor da expressão é igual a Verdadeiro ou 2 - uetOnValueChanged:
o Evento de Usuário dispara quando o valor da expressão é alterado.

Programando no Elipse E3 53
CAPÍTULO
Bibliotecas do Usuário
3
Esta seção contém informações sobre os objetos ElipseX (XControls, XFolders e XObjects).

3.1 ElipseX
Esta seção contém informações sobre eventos e propriedades comuns aos objetos ElipseX (XControls, XFolders e
XObjects). Estes objetos não possuem métodos comuns associados.

3.1.1 Eventos Comuns

Esta seção contém informações sobre os eventos comuns aos objetos ElipseX (XControls, XFolders e XObjects).

[Link] Constructor
Constructor()
Disparado quando o ElipseX é iniciado. Pode-se utilizar este evento para executar um script que inicie valores internos
de um ElipseX, por exemplo.

[Link] CustomConfig
CustomConfig()
Permite configurações automatizadas nas instâncias de objetos ElipseX. Uma opção de configuração aparece no menu
contextual das instâncias de objetos ElipseX sempre que existir um script associado a este evento da definição do
objeto ElipseX. Quando esta opção é selecionada no menu contextual, o evento é disparado. O texto que aparece na
opção do menu contextual pode ser informado na propriedade CustomConfigText da definição do objeto ElipseX.
Se esta propriedade estiver em branco, aparece o texto "Configurar".

54 Bibliotecas do Usuário
 Menu contextual da instância do objeto ElipseX

NOTA
O script associado a este evento executa no Elipse E3 Studio, onde os objetos não estão ativos. Portanto, o
comportamento é diferente do usual.

3.1.2 Propriedades Comuns

Esta seção contém informações sobre as propriedades comuns aos objetos ElipseX (XControls, XFolders e XObjects).

[Link] Contexts
Define uma variável de contexto usada em expressões de Associações. Para mais informações sobre contextos, veja
o método Context no tópico Eventos, Métodos e Propriedades Gerais dos Objetos.

NOTA
O valor desta propriedade não permite caracteres especiais, apenas letras (sem diferenciar maiúsculas e minúsculas)
e números.

Bibliotecas do Usuário 55
[Link] CustomConfigText
Indica o texto que deve aparecer no menu contextual para a opção de configuração da instância do ElipseX. A
opção só aparece se existir um script associado ao evento CustomConfig da definição do ElipseX. Se o valor da
propriedade estiver em branco, aparece o texto "Configurar" na opção do menu contextual. O valor padrão desta
propriedade é uma String vazia.

[Link] DefaultIsAlarmArea
Define o comportamento de habilitar ou não a propriedade IsAlarmArea nas instâncias do ElipseX.

NOTA
Esta propriedade não está disponível para XControls.

[Link] EnableTagBehavior
Esta propriedade permite habilitar um comportamento de Tag a uma instância do ElipseX, ou seja, se a instância
contém pelo menos as propriedades Value, Quality e Timestamp, os valores destas propriedades são sempre
propagados em conjunto. O valor padrão desta propriedade é Falso. Ao habilitar esta propriedade, o Elipse E3
Studio verifica se o ElipseX contém todas as propriedades obrigatórias, Value (do tipo Variant), Quality (do tipo
Word) e Timestamp (do tipo Date). As propriedades a seguir são opcionais e também podem ser criadas durante o
processo de verificação:
· ActiveSource (fonte de medida ativa, do tipo PowerSourceType)
· EU (unidade de engenharia, do tipo String)
· EULow (valor mínimo da propriedade Value, do tipo Double)
· EUHigh (valor máximo da propriedade Value, do tipo Double)

NOTA
· Se alguma das propriedades obrigatórias para o funcionamento do comportamento de Tag (Value, Quality ou
Timestamp) é apagada, isto impede o uso do ElipseX em tempo de execução.
· Da mesma forma, alterar o tipo de dados das propriedades (obrigatórias ou opcionais) para um tipo de dados
incompatível também impede o uso do ElipseX em tempo de execução.
· Configurar esta propriedade em Verdadeiro habilita o comportamento da propriedade ValueMode.

[Link] FriendlyName
Define um nome amigável para a classe do ElipseX, utilizado no menu contextual de inserção de objetos e na janela
Contagem de Objetos do Domínio.

[Link] IconPath
Define o nome do arquivo de imagem a ser utilizado como ícone para as instâncias do ElipseX. Este ícone é
mostrado no menu contextual Inserir de Telas (para XControls) e Servidores de Dados (para XFolders e XObjects),
bem como no Organizer e AppBrowser, entre outros. Esta propriedade permite arrastar e soltar um arquivo de
imagem inserido como Recurso no projeto. O valor padrão desta propriedade é uma String vazia, ou seja, a instância
do ElipseX mostra o ícone para XControls, o ícone para XFolders e o ícone para XObjects.

[Link] InstanceName
Define um nome padrão para as instâncias criadas a partir do ElipseX. Consulte a propriedade geral Name para
mais informações sobre os caracteres permitidos no nome desta instância.

[Link] ValueMode
Esta propriedade informa se as instâncias de um ElipseX possuem valores analógicos, discretos ou não definidos.
Os valores possíveis para esta propriedade são 0: vmUndefined (valor padrão), 1: vmAnalog ou 2: vmDiscrete. Esta
propriedade somente tem efeito se a propriedade EnableTagBehavior estiver configurada em Verdadeiro.

56 Bibliotecas do Usuário
3.1.3 Objeto Definição de Propriedades
Esta seção contém informações sobre eventos e propriedades do objeto Definição de Propriedades (XMethod). Este
objeto não possui métodos associados.

[Link] Eventos
Esta seção contém informações sobre os eventos do objeto Definição de Propriedades (XMethod).

[Link].1 OnPropertyChanged
OnPropertyChanged()
Ocorre quando uma Definição de 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.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Definição de Propriedades (XMethod).

[Link].1 DefaultValue
Define o valor inicial para a Definição de Propriedade quando uma nova instância do objeto é criada. Se a Definição
de Propriedade está configurada como retentiva, ela é inicializada com este valor cada vez que o objeto é carregado.
O valor padrão desta propriedade é vazio (empty).

[Link].2 ExposableToOpc
Indica como uma Definição de Propriedade é exposta no Servidor OPC UA. Os valores possíveis para esta
propriedade são 0 - eDontExpose: Esta Definição de Propriedade não é exposta no Servidor OPC UA, 1 - eExpose:
Esta Definição de Propriedade é exposta no Servidor OPC UA para leitura e escrita ou 2 - eExposeAsReadOnly: Esta
Definição de Propriedade é exposta no Servidor OPC UA somente para leitura.

[Link].3 HelpString
Texto contendo a descrição da Definição de Propriedade. Este texto é mostrado na parte inferior da Lista de
Propriedades no Elipse E3 Studio quando a Definição de Propriedade é selecionada. O valor padrão desta
propriedade é uma String vazia.

[Link].4 Persistable
Indica se a Definição de 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 é configurada com
o valor Falso, a Definição de Propriedade não pode ser editada no Elipse E3 Studio, nem salva ou lida do arquivo de
projeto. Entretanto, a Definição de Propriedade ainda é visível no AppBrowser. Esta propriedade é representada pelo
ícone .
Quando esta propriedade está configurada para Verdadeiro, a Definição de Propriedade recebe seu valor padrão
(propriedade DefaultValue) apenas na criação de uma instância. Se a propriedade DefaultValue é alterada, as
instâncias do objeto já criadas não são afetadas.
Quando esta propriedade está configurada para Falso, a Definição de Propriedade recebe seu valor padrão sempre
que uma instância é carregada, ou seja, sempre que a propriedade DefaultValue é alterada, todas as instâncias já
criadas são inicializadas com o novo valor padrão.

[Link].5 Public
Quando uma Definição de Propriedade de um ElipseX é pública (Verdadeiro), ela é visível fora da Biblioteca. Caso
contrário, a Definição de Propriedade é interna e somente visível para o objeto. O valor padrão desta propriedade é
Verdadeiro. A Definição de Propriedade pública é representada pelo ícone .

[Link].6 Retentive
Indica se o valor atual da Definição de Propriedade em tempo de execução é persistido no arquivo de Domínio
(Verdadeiro), enquanto o Domínio estiver carregado. Uma Definição de Propriedade retentiva é representada pelo
ícone . Definições de Propriedade retentivas têm o seguinte comportamento:
· Propagam o seu valor para o servidor em Standby

Bibliotecas do Usuário 57
 · 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
· Esta propriedade somente está disponível para Definições de Propriedades cujo tipo de dados não seja um
objeto, como por exemplo Variant, Double ou Integer.
· O uso desta propriedade em Verdadeiro implica em um aumento no uso de memória e CPU por parte do E3Run,
por isto deve ser utilizada com cautela.

[Link].7 Type
Determina o tipo de valores que a Definição de Propriedade aceita, como por exemplo Boolean, Double, Integer
ou Variant, entre outros. Quando é especificado um objeto como tipo, como por exemplo DemoTag, IOTag ou
XObject, entre outros, esta propriedade tem 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 exista. Se o caminho não aponta
para um objeto existente no momento, a propriedade retorna Nothing

58 Bibliotecas do Usuário
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 E3:
· Viewer
· Quadros e Divisores
· Telas e Objetos de Tela
· E3Alarm
· E3Browser
· E3Chart
· E3Playback
· Relatório de Seção
· TrendAnalysis

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.

[Link] OnInactive
OnInactive()
Este evento ocorre enquanto o Elipse E3 Viewer está inativo e se a propriedade EnableInactivity está configurada
em Verdadeiro. Este evento inicia quando se constata que o usuário está sem utilizar o Elipse E3 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 uma ação quando o Elipse E3 Viewer está 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 Elipse E3 Viewer, como no exemplo a seguir.
Sub Viewer_OnInactive()
Logout(false)
If MsgBox("Essa sessão do Elipse E3 Viewer foi fechada_
devido à inatividade.") = 0 Then
[Link]("").OpenScreen "TelaInicial", 0
End Sub

[Link] Eventos de Usuário

Esta seção contém informações sobre eventos de usuário do objeto Viewer.

[Link].1 OnLogin
OnLogin()
Ocorre quando um usuário executa um login na aplicação, ou 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.

[Link].2 OnLogout
OnLogout()
Ocorre quando é executado um logout, ou seja, a saída do usuário de uma aplicação. O logout é realizado 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.

Visualização 59
[Link] CaptureScreen
CaptureScreen(FileName)
Este método 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.

NOTA
O formato final do arquivo é Bitmap, um arquivo com a extensão .bmp, mesmo que no parâmetro FileName seja
informada outra extensão, como por exemplo .gif ou .jpg.

O código a seguir contém um exemplo de uso deste método.

Sub CommandButton1_Click()
[Link] "c:\temp\[Link]"
End Sub

[Link] ChangePassword
ChangePassword([PosX], [PosY])
Este método abre uma caixa de diálogo para permitir a troca de senha do usuário atual e retorna Verdadeiro se o
usuário atual tem permissão para trocar a senha ou retorna Falso se houve falha na operação ou se não é possível
trocar a senha porque o usuário não tem autorização.
Este método tem os parâmetros opcionais PosX, que indica a posição em pixels da caixa de diálogo em relação à
margem esquerda da janela, e PosY, que indica a posição em pixels da caixa de diálogo em relação à margem
superior da janela. Caso algum destes parâmetros seja omitido, a respectiva coordenada da caixa de diálogo é
centralizada na janela. Caso os valores indicados nestes parâmetros posicionem a caixa de diálogo fora da área visível
da janela, estes valores são ajustados automaticamente para garantir que a caixa de diálogo esteja visível.

NOTAS
· Este método só está disponível se o usuário logado é um usuário do Domínio do Elipse E3.
· Sempre que o usuário atual troca a senha, é realizado um logout de todas as sessões onde este usuário estava
logado, exceto da sessão onde foi realizada a troca de senha.

[Link] ChangeUserPassword
ChangeUserPassword(Username, PasswordOld, PasswordNew, [OpStatus])
Este método permite alterar a senha de um usuário sem mostrar nenhuma mensagem. O parâmetro Username é o
nome do usuário, o parâmetro PasswordOld é a senha atual deste usuário e o parâmetro PasswordNew é a nova senha.
O parâmetro opcional de retorno OpStatus é um mapa de bits que indica o status desta operação. Este método
retorna um Booleano indicando se a operação falhou ou não. Consulte a tabela Valores de retorno possíveis para o
parâmetro OpStatus no método LoginUser para mais informações sobre os valores possíveis em caso de falha.

NOTA
Sempre que um usuário troca a senha, é realizado um logout de todas as sessões onde este usuário estava logado,
exceto da sessão onde foi realizada a troca de senha.

[Link] 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 não é fechada. O
parâmetro Title passado neste método só é utilizado se a propriedade Caption está 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

60 Visualização
 · 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 é igual a -1 (menos um,
usado quando o parâmetro e omitido), são adotadas as configurações do Viewer para a janela modal. Quando
este valor é diferente de -1 (menos um), pode-se usar as combinações descritas na tabela a seguir
Combinações possíveis para o parâmetro Flags
VALOR DESCRIÇÃO
1 Habilita a barra de título na janela

2 Habilita o botão Fechar na janela

4 Habilita o botão Minimizar na janela

8 Habilita o botão Maximizar na janela

16 Habilita a borda na janela

32 Especifica que a janela pode ser dimensionada

64 Especifica que a janela pode ser movida

256 Especifica que a janela permanece no topo da Tela

512 Especifica que a janela é configurada no estilo Barra de

Ferramentas

1024 Desabilita os botões de objeto

2048 Centraliza a Tela modal no Quadro, tanto horizontal

quanto verticalmente

O código a seguir contém um exemplo de uso deste método.

Sub Botao1_Click()
' Ao clicar no Botão, abre uma outra Tela modal
[Link] "Tela1", "Titulo", 0, 0, 400, 200, 0, 3
End Sub

NOTA
Os valores de tamanho neste método podem ser informados como números ou Strings. No caso de números, são
considerados em pixels. No caso de Strings, se vierem acompanhados da unidade "hm", são interpretados como
Himetric. Qualquer outro caso é considerado em pixels.

[Link] ESign
ESign(ObjName, [Description], [Action], [From], [To], [User], [Comment])
Este método é utilizado para validar a 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 61
 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 Tag ou outro objeto da
aplicação

Description Texto que contém a descrição de ObjName. Este

parâmetro é opcional e, se omitido, a caixa de diálogo
tenta buscar os dados da propriedade DocString de
ObjName

Action Texto que contém a ação a ser executada, como por

exemplo "Alteração do valor". Este parâmetro é opcional
e, se omitido, insere uma String vazia no campo Ação

From Variant que contém o valor original ou o estado a ser

alterado. Este parâmetro é opcional e, se omitido, insere
uma String vazia no campo De

To Variant que contém o novo valor do Tag ou o valor a

ser aplicado em Action. Este parâmetro é opcional e, se
omitido, insere uma String vazia no campo Para

User Texto de retorno. Recebe o nome de login selecionado

na caixa de diálogo. Este parâmetro é opcional e, se
omitido, insere uma String vazia no campo Usuário

Comment Texto de retorno. Recebe o comentário digitado na caixa

de diálogo. Este parâmetro é opcional e, se omitido,
insere uma String vazia no campo Comentário

Ao clicar em , abre-se uma janela que permite autenticar o usuário. Se a opção Windows é selecionada, os campos
Nome do usuário e Senha são automaticamente desabilitados. Clique em Outro usuário para selecionar um usuário
pertencente ao domínio de rede. Caso a opção E3 seja selecionada, digite as informações de um usuário pertencente
ao Domínio do Elipse E3 nos campos Nome do usuário e Senha.

62 Visualização
 Login integrado
Este método retorna Verdadeiro se o usuário clica em OK, e se os campos Usuário e Senha são válidos. Caso
contrário, se a caixa de diálogo é 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 é informado pelo usuário, este é salvo e o mais antigo é descartado, caso
não haja posição livre. Se um comentário já existente é utilizado, este passa a ser o primeiro da lista de comentários
mais recentes. O código a seguir contém um exemplo de uso deste método.
Sub Button1_Click()
Dim Tag, User, Comment
Set Tag = [Link]("[Link].I001")
If [Link]([Link], , "Alteração do Valor", _
[Link], 1, User, Comment) Then
If [Link](1) Then
[Link] _
"Tag [Link].I001 alterado para 1 " &_
"pelo usuário" & User, Comment
End If
End If
End Sub

[Link] ExecuteExternalApp
ExecuteExternalApp(AppPath, Arguments, InitialDir, CmdShow, [ProcessId])
Este método executa uma aplicação externa de nome e caminho indicado no parâmetro AppPath, com os argumentos
indicados pelo parâmetro Arguments, iniciando no diretório de trabalho indicado pelo parâmetro InitialDir. Quando
especificado um documento no parâmetro AppPath, a aplicação associada a este documento é executada e o
documento é passado como um dos parâmetros da aplicação. O parâmetro ProcessID é opcional e recebe o número
que identifica o processo da aplicação externa no sistema operacional. 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 da aplicação, conforme descrito na tabela a seguir.
Opções disponíveis para o parâmetro CmdShow
OPÇÃO DESCRIÇÃO
0 Esconde a janela e ativa outra janela

1 Ativa e mostra a janela. Se a janela estiver maximizada ou

minimizada, ela é restaurada para o tamanho e posição
originais. Uma aplicação deve especificar este valor
quando estiver mostrando uma janela pela primeira vez

2 Ativa a janela e mostra-a minimizada

3 Ativa a janela e mostra-a maximizada

4 Mostra a janela com seu tamanho e posição mais

recentes. A janela ativa permanece ativa

Visualização 63
 OPÇÃO DESCRIÇÃO
5 Ativa a janela e mostra-a com seu tamanho e posição
atuais

6 Minimiza a janela e ativa a próxima janela de nível

superior

7 Mostra a janela minimizada. A janela ativa permanece

ativa

8 Mostra a janela em seu estado atual. A janela ativa

permanece ativa

9 Ativa e mostra a janela. Se a janela estiver maximizada ou

minimizada, ela é restaurada para o tamanho e posição
originais. Uma aplicação deve especificar este valor
quando estiver restaurando uma janela que estava
minimizada

O código a seguir contém um exemplo de uso deste método.

Sub CommandButton1_Click()
Dim ret
[Link] "[Link]", "", "", 1, ret
[Link]("Dados.TagInterno1").Value = ret
End Sub

NOTA
O parâmetro retornado em ProcessID pode ser 0 (zero), caso nenhum processo tenha sido iniciado. Por exemplo, se
um documento aberto é uma URL e uma instância do Internet Explorer já está em execução, esta instância mostra o
documento. Nenhum processo novo é iniciado, portanto ProcessID é 0 (zero).

[Link] Exit
Exit()
Este método fecha a janela do Elipse E3 Viewer. O código a seguir contém um exemplo de uso deste método.
Sub_Botao1.Click()
[Link]()
EndSub

[Link] 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, ou valores. Este método possui o parâmetro FormulaName, que é o nome da Fórmula.
Utilize este método 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. O código a seguir contém um exemplo de uso deste
método.
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 = [Link]("Formula1")
MsgBox CStr([Link])
MsgBox CStr([Link](1))
End Sub

[Link] 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 este método 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. O código a seguir contém um exemplo de uso deste método.

64 Visualização
 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 = [Link]("Formula1")
MsgBox CStr([Link])
MsgBox CStr([Link](1))
End Sub

[Link] GetFrame
GetFrame([FrameName], [CreateNew])
Este método procura por um objeto Divisor que já esteja aberto no Elipse E3 Viewer atual. Este método possui os
parâmetros FrameName, que é opcional e determina o nome do Quadro a ser buscado, e CreateNew, que também é
opcional e determina se é necessário criar uma nova janela caso o Quadro não seja encontrado. Caso o valor
especificado em FrameName seja omitido ou uma String vazia, retorna um Quadro que contém todos os Divisores ou
a Tela ativa no momento. Caso o parâmetro CreateNew seja omitido ou configurado como Verdadeiro, uma nova
janela é criada. Com o retorno deste método, utilize os métodos do Divisor, como por exemplo o método
OpenScreen, para abrir uma outra Tela. O código a seguir contém um exemplo de uso deste método.
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 = [Link]("Menu")
' novoQuadro possui um objeto do tipo Divisor
[Link] "Opções", 0
End Sub

NOTA
Caso o nome passado no parâmetro FrameName se refira a um Quadro não existente e o parâmetro CreateNew seja
configurado como Falso, este método retorna Nothing, ou seja, não retorna nenhum Quadro.

[Link] GetFullUserName
GetFullUserName()
Este método retorna o nome completo do usuário logado no Elipse E3. Caso não haja nenhum usuário logado,
retorna uma String vazia.

[Link] GetKeyPad
GetKeyPad()
Retorna uma referência para o objeto Elipse KeyPad, permitindo manipular um teclado virtual flutuante em aplicações
desenvolvidas com o Elipse E3. Consulte o Manual do Usuário do Elipse E3 para mais informações sobre este
objeto. Os métodos e propriedades do Elipse KeyPad estão descritos no capítulo ActiveX - Elipse KeyPad.

[Link] GetMouseX
GetMouseX()
Retorna a coordenada X do ponteiro do mouse, em pixels, referente à área total da tela do computador.

NOTA
Este método falha em um script se a posição atual do ponteiro do mouse não pode ser determinada. Uma das
situações onde esta falha pode ser verificada é o caso de estar aberta a janela de Logon do Windows, ou seja, ao
pressionar o atalho de teclado CTRL + ALT + DEL. Este comportamento de impedir o acesso à posição atual do
ponteiro do mouse é padrão do Windows em algumas situações e não pode ser contornado. Sugere-se utilizar a
instrução On Error Resume Next antes da utilização deste método, para evitar erros de script.

[Link] GetMouseY
GetMouseY()
Retorna a coordenada Y do ponteiro do mouse, em pixels, referente à área total da tela do computador.

Visualização 65
NOTA
Este método falha em um script se a posição atual do ponteiro do mouse não pode ser determinada. Uma das
situações onde esta falha pode ser verificada é o caso de estar aberta a janela de Logon do Windows, ou seja, ao
pressionar o atalho de teclado CTRL + ALT + DEL. Este comportamento de impedir o acesso à posição atual do
ponteiro do mouse é padrão do Windows em algumas situações e não pode ser contornado. Sugere-se utilizar a
instrução On Error Resume Next antes da utilização deste método, para evitar erros de script.

[Link] 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.

[Link] GetTrendAnalysis
GetTrendAnalysis([Title])
Retorna um objeto que permite configurar a janela do TrendAnalysis. O parâmetro Title indica um título, opcional, para
a janela do TrendAnalysis. Caso este parâmetro seja omitido, a janela do TrendAnalysis recebe a expressão
"TrendAnalysis". Em um script, deve-se utilizar este método conforme o código a seguir.
Sub
Set TA = [Link]("TrendAnalysis Window")
End Sub

Para mais informações sobre propriedades e métodos deste objeto, consulte o tópico TrendAnalysis.

[Link] GetValue
GetValue(TagName)
Este método 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. O código a seguir contém um exemplo de uso
deste método.
Sub Botao1_Click()
' Ao clicar no Botão,
' recupera o valor de um Tag
' sendo executado em um Servidor de Dados
X = [Link]("Dados1.TagInterno1")
End Sub

[Link] IsAppRunning
IsAppRunning(ProcessId)
Indica se uma aplicação iniciada pelo método ExecuteExternalApp está em execução. Retorna Verdadeiro se a
aplicação identificada no sistema operacional por ProcessId está em execução. Caso contrário, retorna Falso. O código
a seguir contém um exemplo de uso deste método.
Sub CommandButton1_Click()
[Link] _
"[Link]", "", "", 1, processID
While [Link](processID)
' Espera pelo final da aplicação
Wend
MsgBox "Terminou a aplicação!"
End Sub

NOTA
O parâmetro ProcessId é o mesmo valor que aparece no Gerenciador de Tarefas do Windows, na coluna PID.

[Link] 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

66 Visualização
 · UserName: Nome do usuário que se quer verificar. Se este parâmetro é omitido ou é igual a uma String vazia, o
método considera o usuário atualmente logado no Elipse E3 Viewer

Este método retorna Verdadeiro se o usuário pertencer ao grupo indicado por GroupName ou Falso caso contrário.

[Link] IsWebViewer
IsWebViewer()
Verifica se a aplicação está sendo visualizada pelo WebViewer. O método retorna Verdadeiro se a aplicação estiver
sendo executada no WebViewer. Caso contrário, retorna Falso.

[Link] LoadFormulaDlg
LoadFormulaDlg(FormulaName, [UnitName], [ValueName])
Este método abre uma caixa de diálogo que exibe as Unidades e os Conjuntos de Valores configurados em uma
Fórmula (FormulaName), permitindo ao usuário selecionar o Conjunto de Valores e a Unidade em que este Conjunto é
carregado.
Os parâmetros opcionais UnitName e ValueName são variáveis que recebem, respectivamente, o nome da Unidade e
o nome do Conjunto de Valores carregados na Fórmula. A caixa de diálogo da figura a seguir é mostrada como
resultado da chamada a este método no código de exemplo que segue. Este método retorna um valor Booleano
indicando se foi executado com sucesso ou não.

Caixa de diálogo do método LoadFormulaDlg

O código a seguir contém um exemplo de uso deste método.

Sub Botao1_Click()
NomeFormula = "Formula1"
If [Link](NomeFormula, NomeUnidade, ConjuntoValores) Then
MsgBox "O Conjunto de Valores " & ConjuntoValores & " foi carregado na Unidade " &
NomeUnidade
Else
MsgBox "Falha ao carregar a Fórmula " & NomeFormula
End If
End Sub

[Link] 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.

Visualização 67
NOTA
Este método retorna um valor lógico, ou seja, retorna Verdadeiro quando é executada com sucesso e Falso quando
falha, o que não significa que houve um erro no script.

O código a seguir contém um exemplo de uso deste método.

Sub Botao1_Click()
[Link] "Formula1",
"Unidade1", "Valor1"
End Sub

[Link] 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. O código a seguir contém um exemplo de uso
deste método.
Sub Botao1_Click()
[Link] "Formula1",_
"Unidade3", "Valor1"
End Sub

NOTA
Este método também está acessível através do objeto Fórmula.

[Link] LoadReport
LoadReport(ReportName)
Carrega um modelo de Relatório de Seção. O parâmetro ReportName é o nome do Relatório de Seção a ser
carregado. O código a seguir contém um exemplo de uso deste método.
Sub Rect_Click()
' Carregando o Relatório de Seção pré-definido
Set strRep = [Link]("[Relatório3]")
[Link] ' Visualizando a impressão
End Sub

[Link] Login
Login([Mode], [PosX], [PosY], [WindowsShowLastCredentials])
Abre uma caixa de diálogo para o login, ou autenticação de usuário, na aplicação. O usuário logado permanece na
memória até que seja realizado outro login ou logout, ou saída do usuário da aplicação. Os parâmetros deste método,
todos opcionais, são os seguintes:
· Mode: Um Booleano que determina se uma mensagem de confirmação ou falha da operação deve ser mostrada.
Se este parâmetro é omitido, a mensagem de confirmação ou falha de operação não é mostrada. 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
· PosX: Indica a posição, em pixels, da caixa de diálogo em relação à margem esquerda da janela. Caso este
parâmetro seja omitido, a respectiva coordenada da caixa de diálogo é centralizada na janela
· PosY: Indica a posição, em pixels, da caixa de diálogo em relação à margem superior da janela. Caso este
parâmetro seja omitido, a respectiva coordenada da caixa de diálogo é centralizada na janela
· WindowShowLastCredentials: Um Booleano que indica se, ao selecionar a autenticação pelo Windows, os
campos de usuário e senha são completados com o usuário atualmente logado no Windows. Se este parâmetro é
omitido, os campos de usuário e senha são completados

NOTA
Caso ambos os parâmetros PosX e PosY sejam omitidos, a caixa de diálogo é centralizada na janela.

68 Visualização
[Link] LoginUser
LoginUser(Username, UserPassword, [OpStatus], [WarnDaysToExpire])
Executa uma operação de 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 parâmetro opcional de retorno OpStatus é
um mapa de bits que indica o status desta operação e o parâmetro opcional de retorno WarnDaysToExpire indica o
número de dias para que a senha em UserPassword expire. Este método retorna um Booleano indicando se a
operação falhou ou não. Consulte as tabelas a seguir para mais informações sobre os valores possíveis em caso de
falha.

NOTA
Este método só está disponível se o usuário logado é um usuário do Domínio do Elipse E3.

Valores de retorno possíveis para o parâmetro OpStatus

VALOR DESCRIÇÃO
0x000000 Nenhum erro

0x000001 Erro não especificado

0x000002 Usuário ou senha incorretos

0x000004 A senha atual deve ser alterada

0x000008 A senha atual expirou

0x000010 A conta deste usuário está bloqueada

0x000020 A conta deste usuário está desabilitada

0x000040 O servidor RPC não está disponível

0x000080 Modo de autenticação não suportado

0x001000 Senha não informada

0x002000 Este usuário não tem permissão para alterar a senha

0x004000 A senha informada não é alfanumérica

0x008000 A senha informada não possui letras maiúsculas e

minúsculas

0x010000 A senha informada é muito curta

0x020000 A senha informada não possui a quantidade mínima de

números

0x040000 A senha informada não possui a quantidade mínima de

letras

0x080000 A senha informada não possui a quantidade mínima de

caracteres especiais

0x100000 A senha informada é igual ao nome do usuário

0x200000 A senha informada foi utilizada recentemente

0x400000 A senha atual não atingiu a idade mínima

Valores de retorno possíveis para o parâmetro WarnDaysToExpire

VALOR DESCRIÇÃO
-1 (menos um) A senha está fora do intervalo de expiração ou nunca
expira

0 (zero) A senha expira hoje

Visualização 69
 VALOR DESCRIÇÃO
n A senha expira daqui a n dias dentro do intervalo de
expiração configurado

[Link] LoginWindowsUser
LoginWindowsUser([UserName], [UserPassword], [OpStatus])
Este método executa uma operação de login utilizando um usuário do Windows sem mostrar nenhuma mensagem. O
parâmetro opcional UserName é o nome do usuário e o parâmetro opcional UserPassword é a senha deste usuário. O
parâmetro de retorno opcional OpStatus é um mapa de bits que indica o status desta operação. Este método retorna
um Booleano indicando se a operação falhou ou não. Consulte a tabela Valores de retorno possíveis para o
parâmetro OpStatus no método LoginUser para mais informações sobre os valores possíveis em caso de falha. Caso
o nome do usuário seja omitido, a operação de login é executada com o usuário corrente do Windows.

[Link] Logout
Logout([Mode])
Executa o logout, ou saída do usuário atual da aplicação, do Elipse E3 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. Se este parâmetro é omitido, a mensagem de confirmação ou falha de
operação não é mostrada.

[Link] PasswordConfirm
PasswordConfirm([Mode], [PosX], [PosY])
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 é confirmada ou Falso caso contrário. O parâmetro opcional Mode determina se deve ser
executado um logout em caso de falha na confirmação (Verdadeiro) ou não (Falso). Se omitido, não é executado um
logout em caso de falha de confirmação. O parâmetro opcional PosX indica a posição, em pixels, da caixa de diálogo
em relação à margem esquerda da janela. Caso este parâmetro seja omitido, a respectiva coordenada da caixa de
diálogo é centralizada na janela. O parâmetro opcional PosY indica a posição, em pixels, da caixa de diálogo em
relação à margem superior da janela. Caso este parâmetro seja omitido, a respectiva coordenada da caixa de diálogo
é centralizada na janela. Caso os valores indicados nos parâmetros PosX e PosY posicionem a caixa de diálogo fora da
área visível da janela, estes valores são ajustados automaticamente para garantir que a caixa de diálogo esteja visível.

Confirmação de senha
Se a caixa de diálogo é fechada clicando em Cancelar, este método retorna Falso. Caso não haja usuário logado, este
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 este método retorna Falso.

NOTA
Este método só está disponível se o usuário logado é um usuário do Domínio do Elipse E3.

70 Visualização
[Link] Playsound
Playsound(FileName)
Executa um arquivo de som cujo caminho e nome estão indicados no parâmetro FileName. O arquivo deve ter as
seguintes especificações:
· Deve estar no formato de som do Windows, com a extensão .wav
· Se o arquivo está 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, como por exemplo "c:\som\[Link]". Se o arquivo está no diretório local, o
nome não precisa de aspas, apenas o caminho, como por exemplo c:\som\[Link]

O código a seguir contém um exemplo de uso deste método.

Sub TelaInicial_OnAlarm()
' Se existir um alarme ativo, executa um som de alerta.
' Quando o alarme é reconhecido, o som para.
Set Alarme = Application._
GetObject("ConfigAlarmes1.Area1.FonteAlarme1")
If [Link] = True Then
[Link]("[[Link]]")
End If
End Sub

[Link] 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 por uma barra vertical (|), e 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 opcionais 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, em que 1 (um) é a primeira
opção contida no texto, 2 (dois) é a segunda opção, e assim por diante. O código a seguir contém um exemplo de
uso deste método.
Sub Botao1_Click()
op = _
[Link](_
"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

[Link] SetValue
SetValue(TagName, NewVal)
Este método configura o valor de um objeto dentro do servidor. Este método 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. O código a seguir contém um
exemplo de uso deste método.
Sub Botao1_Click()
' Ao clicar em Botao1, atribui o valor 20
' para a propriedade Value do Tag

Visualização 71
 [Link] "Dados1.TagInterno1", 20
End Sub

[Link] 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 confirma
a data ou Falso se o usuário cancela 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 opcionais 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 opcional DefaultDate é a data e a hora do momento em que a caixa de
diálogo é aberta. Se não é informada a data, assume a data atual. Se não é informada a hora, inicia como "00:00:00".
Se nem a data nem a hora são informadas, inicia com a data e a hora atuais. O código a seguir contém um exemplo
de uso deste método.
Sub Texto2_Click()
Dim novaHora
[Link] novaHora, 300, 300
MsgBox "A hora é: " & novaHora
End Sub

[Link] 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 é informada. Caso seja omitido ou seja uma String vazia, 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. Se omitido, assume o valor 2 (dois, FILEMUSTEXIST). 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 String indica o tipo de extensão a ser utilizada. Se omitido, nenhum filtro
é aplicado aos arquivos.
Combinações possíveis para o parâmetro Flags
VALOR DESCRIÇÃO
1 CREATEPROMPT: Se o usuário especificar um arquivo
que não existe, este flag permite que seja questionado
sobre a criação do arquivo. Ao selecionar criar o arquivo,
a caixa de diálogo é fechada e o nome do arquivo é
retornado no parâmetro Filename. Caso contrário, a caixa
de diálogo permanece aberta

2 FILEMUSTEXIST: Especifica que o usuário só pode

digitar nomes de arquivos existentes. Caso contrário, a
caixa de diálogo mostra um aviso na caixa de mensagens

4 NOCHANGEDIR: Recupera o diretório atual para o valor

original, caso o usuário tenha mudado de diretório
enquanto buscava o arquivo

8 NODEREFERENCELINKS: Configura a caixa de diálogo

para retornar o arquivo de atalho (.lnk) selecionado. Se
este flag não é especificado, a caixa de diálogo retorna o
caminho e nome de arquivo referenciados pelo arquivo
de atalho

16 NOREADONLYRETURN: Determina que o arquivo

retornado não seja somente para leitura, e o diretório
não é protegido contra gravação

72 Visualização
 VALOR DESCRIÇÃO
32 PATHMUSTEXIST: Especifica que o usuário pode
informar apenas arquivos e diretórios válidos, caso
contrário uma caixa de mensagem é mostrada para
avisar o usuário

64 READONLY: Permite que a opção Somente Leitura seja

selecionada inicialmente quando a caixa de diálogo é
criada

128 OVERWRITEPROMPT: Permite que a caixa de diálogo

Salvar Como gere uma mensagem informando da
existência do arquivo, e pede confirmação para
sobrescrever este arquivo

O código a seguir contém um exemplo de filtro para este método.

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

[Link] 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 opcional Color indica uma cor previamente selecionada na paleta de cores. Se
este parâmetro não é informado, assume o valor 0 (zero, preto). A posição da caixa de diálogo pode ser configurada
através dos parâmetros opcionais 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. O código a seguir
contém um exemplo de uso deste método.
Sub CommandButton_Click()
Dim novaCor
Dim corPadrao
corPadrao = 65280 ' Verde Claro
If [Link](novaCor, corPadrao, 90, 90) Then
[Link]("Retangulo1").ForegroundColor = novaCor
[Link]("Texto1").Value = novaCor
End If
End Sub

[Link] ShowTrendAnalysis
ShowTrendAnalysis([Title], [Left], [Top], [Configuration], [ConfigStatus], [ErrorDetails])
Mostra uma janela do TrendAnalysis. Este método retorna Verdadeiro se a janela foi mostrada corretamente ou Falso
em caso de erro. Os parâmetros deste método estão listados na tabela a seguir.
Parâmetros do método ShowTrendAnalysis
PARÂMETRO DESCRIÇÃO
Title Determina o título da janela. Corresponde à propriedade
Title do objeto TrendAnalysis. Se omitido ou informada
uma String vazia, o título da janela é configurado para
"TrendAnalysis"

Left Coordenada horizontal da janela, em pixels. Consulte o

método SetWindowPlacement do objeto TrendAnalysis
para mais informações sobre o comportamento deste
parâmetro, caso seja omitido

Top Coordenada vertical da janela, em pixels. Consulte o

método SetWindowPlacement do objeto TrendAnalysis
para mais informações sobre o comportamento deste
parâmetro, caso seja omitido

Visualização 73
 PARÂMETRO DESCRIÇÃO
Configuration Informa o conteúdo de uma configuração salva pelo
método Save do objeto TrendAnalysis. Se omitido ou
informada uma String vazia, não carrega nenhuma
configuração previamente salva

ConfigStatus Parâmetro opcional de retorno que informa o resultado

do carregamento da janela do TrendAnalysis. Se este
método retorna Verdadeiro, este parâmetro contém o
valor 0 (zero), ou seja, a configuração foi carregada com
sucesso. Se este método retorna Falso, este parâmetro
pode conter os valores 1: A configuração não carregou
corretamente, 2: O conteúdo da configuração é inválido
ou 3: Esta configuração requer uma versão mais recente

ErrorDetails Parâmetro opcional de retorno contendo uma String

detalhando o erro no carregamento da janela do
TrendAnalysis

O código a seguir contém um exemplo de uso deste método.

Sub Botao1_Click()
Dim showResult, errorMsg, errorDetails
showResult = [Link]("TrendAnalysis", 100, 100, "", ConfigStatus,
errorDetails)
If showResult = False Then
If ConfigStatus <> 0 Then
Select Case ConfigStatus
Case 1
errorMsg = "Erro (1): A configuração não foi carregada corretamente."
Case 2
errorMsg = "Erro (2): O conteúdo da configuração é inválido."
Case 3
errorMsg = "Erro (3): Esta configuração requer uma versão mais recente."
End Select
errorMsg = errorMsg & vbCrLf & "Detalhes: " & errorDetails
MsgBox errorMsg
End If
End If
End Sub

NOTA
As propriedades do objeto TrendAnalysis podem ser configuradas no objeto retornado pelo método
GetTrendAnalysis.

[Link] Stopsound
Stopsound()
Para um som que esteja executando.

[Link] ToggleValue
ToggleValue(TagName, ValA, ValB)
Este método 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 é 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, este método atribui o
valor especificado em ValA. O código a seguir contém um exemplo de uso deste método.
Sub Botao1_Click()
' Ao clicar no Botão, atribui o valor
' a um Tag sendo executado em um Servidor de Dados.
' Atribui o valor 20 para o Tag.
[Link] "Dados1.TagInterno1", 20
' Já que o valor do TagInterno1 já é 20,
' o método ToggleValue alterna o valor para 30.
[Link] "Dados1.TagInterno1", 30, 20
End Sub

74 Visualização
[Link] Trace
Trace(MessageText, [LogTimeStamp], [BreakLine])
Este método permite registrar mensagens no log do Elipse E3. Este método pode ser usado, por exemplo, para
registrar mensagens de depuração de scripts executados no Viewer.
Parâmetros do método Trace
PARÂMETRO DESCRIÇÃO
MessageText Mensagem definida pelo usuário

LogTimeStamp Booleano que indica se cada registro deve ter a data e a

hora (timestamp). Este parâmetro é opcional e é
ignorado no Elipse E3 Viewer

BreakLine Booleano que indica a presença ou não de uma quebra

de linha ao final de cada mensagem. Este parâmetro é
opcional e é ignorado no Elipse E3 Viewer

[Link] TrackEvent
TrackEvent(EventMessage, [Comment], [EventTimeStamp])
Este método permite gerar eventos via script manualmente. Estes eventos podem ser gerados tanto no Elipse E3
Viewer quanto no Servidor, e são registrados em uma tabela no banco de dados da aplicação.
Parâmetros do método TrackEvent
NOME DESCRIÇÃO
EventMessage Contém a mensagem do evento, com um máximo de 200
caracteres

Comment Contém comentários adicionais sobre um evento, com

um máximo de 200 caracteres. Este parâmetro é opcional
e, se omitido, assume uma String vazia

TimeStamp Indica a data e hora em que um evento ocorreu. Este

parâmetro é opcional e, se omitido, o Elipse E3 assume
a data e a hora atuais

Este método só registra os eventos caso a opção de Registro de Eventos nas Opções do Domínio esteja habilitada.
Os eventos são registrados em uma tabela de um banco de dados, que é definida também nas configurações de
Registro de Eventos.
Para mais informações sobre o Registro de Eventos do Domínio, consulte o Manual do Usuário do Elipse E3. O
código a seguir contém um exemplo de uso deste método.
Sub Button1_Click()
Dim Tag, User, Comment
Set Tag = [Link]("[Link].I001")
If [Link]([Link], , "Alteração do Valor", _
[Link], 1, User, Comment) Then
If [Link](1) Then
[Link] _
"Tag [Link].I001 alterado para 1 " &_
"pelo usuário" & User, Comment
End If
End If
End Sub

[Link] UserAdministration
UserAdministration([PosX], [PosY], [ShowMergeErrorsOnExit], [MergeDetails])
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
as seguintes:
· 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

Visualização 75
 · Editar as configurações de um usuário
· Alterar a senha de um usuário
· Alterar os demais dados de um usuário, tais como nome de login e nome completo

Este método possui os seguintes parâmetros:

· PosX: Parâmetro opcional que indica a posição, em pixels, da caixa de diálogo em relação à margem esquerda
da janela
· PosY: Parâmetro opcional que indica a posição, em pixels, da caixa de diálogo em relação à margem superior da
janela
· ShowMergeErrorsOnExit: Parâmetro Booleano opcional que indica se deve ser mostrada uma janela com os
erros durante a execução deste método. Caso este parâmetro seja omitido, nenhuma janela é mostrada ao final
da execução
· MergeDetails: Parâmetro opcional de saída contendo uma String com os erros acontecidos durante a execução
deste método

Caso os parâmetros PosX e PosY sejam omitidos, a respectiva coordenada da caixa de diálogo é centralizada na
janela, e caso algum dos valores destes parâmetros posicionem a caixa de diálogo fora da área visível da janela, os
valores são automaticamente ajustados para garantir que a caixa de diálogo esteja visível.
Este método retorna Verdadeiro se não houve nenhum problema na edição e Falso caso contrário. O código a seguir
contém um exemplo de uso deste método.
Sub CommandButton_Click()
'Variáveis para receber o resultado
'e os erros de execução
Dim retorno, erro
retorno = [Link]( , , False, erro)
If Not retorno Then
MsgBox "Erros na edição de usuários: " & erro
End If
End Sub

IMPORTANTE
Apenas administradores e usuários com a permissão Configurar usuários/grupos habilitada, disponível no item
Domínios da aba Permissões da janela de edição de usuários, têm acesso à caixa de diálogo aberta por este
método.

4.1.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Viewer.

[Link] AllowContextMenu
Se configurada em Verdadeiro, esta propriedade habilita a exibição do menu contextual das Telas através do botão
direito do mouse em tempo de execução, exceto quando algum script está configurado com informação divergente
nos eventos MouseDown ou MouseUp. Caso contrário, o menu contextual não é mostrado. O valor padrão desta
propriedade é Verdadeiro.

NOTA
Em aplicações anteriores à versão 5.1, o comportamento desta propriedade é configurado pela propriedade
EnableZoomMenu, que foi descontinuada. Ao abrir estas aplicações na versão atual, o comportamento anterior é
atualizado para esta propriedade.

[Link] AllowZoomChange
Esta propriedade habilita a exibição ou não das opções de alteração do nível de zoom no menu contextual das
Telas. O valor padrão desta propriedade é Verdadeiro.

[Link] 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.

76 Visualização
NOTA
O tempo mínimo de atualização da Tela é 55 ms. Portanto, se esta propriedade é configurada com um tempo
inferior, esta configuração não tem efeito algum.

[Link] CacheEnable
Mantém em memória as Telas já abertas instanciadas no Elipse E3 Viewer, permitindo uma troca mais rápida entre
estas Telas. Se esta propriedade está habilitada, então o cache de Telas também é habilitado.

[Link] Caption
Determina o nome da aplicação que está utilizando o Elipse E3 Viewer. O valor padrão desta propriedade é uma
String vazia.

[Link] CenterWindow
Quando habilitada, determina que a janela de visualização do Elipse E3 Viewer deve iniciar centralizada. Caso
contrário, é utilizada a configuração padrão. O valor padrão desta propriedade é Verdadeiro.

[Link] CloseButton
Se esta propriedade está configurada como Verdadeiro, o botão Fechar é habilitado no Elipse E3 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.

[Link] 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)). Consulte a propriedade EnableCommError para mais
informações. Esta propriedade não pode ser alterada em tempo de execução, mesmo que o Elipse E3 Viewer esteja
inativo.

[Link] CommErrorText
Propriedade utilizada para definir o texto de alerta quando uma Associação ou Conexão falha. O valor padrão desta
propriedade é "???". Consulte a propriedade EnableCommError para mais informações. Esta propriedade não pode
ser alterada em tempo de execução, mesmo que o Elipse E3 Viewer esteja inativo.

[Link] 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)). Consulte a propriedade EnableCommError para mais
informações. Esta propriedade não pode ser alterada em tempo de execução, mesmo que o Elipse E3 Viewer esteja
inativo.

[Link] DisableTaskSwitching
Se esta propriedade está configurada para Verdadeiro, desabilita a troca de janelas no Elipse E3 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.

[Link] 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 E3 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. Esta propriedade não pode ser alterada em tempo de execução, mesmo que o Elipse E3 Viewer esteja
inativo.

[Link] EnableHeartbeat
Habilita ou desabilita o envio de uma mensagem de heartbeat (enviada em intervalos fixos, que indica que o
servidor está ativo) entre o Elipse E3 Viewer e o servidor. Caso o Elipse E3 Viewer pare de receber as mensagens de

Visualização 77
heartbeat, é sinal de que algum problema ocorreu, portanto a conexão deve ser abortada. O valor padrão desta
propriedade é Falso.

[Link] EnableInactivity
Habilita ou desabilita a verificação do período de inatividade de um usuário. Para mais informações, consulte o
evento OnInactive do objeto Viewer. O valor padrão desta propriedade é Falso. Esta propriedade não pode ser
alterada com o objeto ativo.

[Link] 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 Elipse E3 Viewer. O valor padrão desta propriedade é 2000 (dois segundos).

[Link] HeartbeatTimeoutMs
Indica o tempo, em milissegundos, que o Elipse E3 Viewer tolera sem receber nenhuma mensagem do Servidor. Se
este tempo passa e nenhuma mensagem é recebida, o Elipse E3 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).

[Link] 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 mais informações, consulte o evento OnInactive do objeto Viewer. O valor padrão desta propriedade é
5 (cinco) minutos. O código a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton3_Click()
MsgBox "A aplicação ficará inativa em " & _
[Link] & " minuto(s)."
End Sub

[Link] InitialScreen
Indica a Tela ou Quadro inicial que deve ser mostrado quando o Elipse E3 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". Para utilizar esta propriedade em scripts, consulte a propriedade SplitLink do
Divisor para mais informações sobre o formato para especificar uma Tela nesta propriedade.

[Link] IsPlaybackMode
Se esta propriedade está configurada para Verdadeiro, indica que o Elipse E3 Viewer está em execução dentro de
um E3Playback, em modo playback. Esta propriedade é somente de leitura.

[Link] IsReadOnly
Se esta propriedade está configurada para Verdadeiro, indica que o Elipse E3 Viewer está no modo Somente
Leitura, ou acesso restrito. Esta propriedade é somente de leitura.

[Link] IsWebView2Enabled
Indica se está habilitado ou não o uso do controle WebView2 do Microsoft Edge como mecanismo de renderização
para exibição de conteúdo da Internet. Esta propriedade é somente de leitura.

[Link] LoginRetries
Especifica o número de retentativas de login do Elipse E3 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).

[Link] MaximizeButton
Se esta propriedade está configurada para Verdadeiro, o botão Maximizar é habilitado no Elipse E3 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.

78 Visualização
[Link] MinimizeButton
Se esta propriedade está configurada para Verdadeiro, o botão Minimizar é habilitado no Elipse E3 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.

[Link] Params
Esta propriedade é um vetor de pares chave-valor que retorna os parâmetros passados para o Elipse E3 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 Elipse E3 Viewer contiver os seguintes parâmetros:
Viewer -params Idioma=PTB

Pode-se utilizar o seguinte código para verificar qual o idioma de inicialização do Elipse E3 Viewer.
Sub TelaInicial_OnStartRunning()
Select Case [Link]("Idioma")
Case "PTB"
Item("Texto1").Value = "Português do Brasil"
Case Else
Item("Texto1").Value = "Idioma não reconhecido"
End Select
End Sub

NOTA
A String da chave não diferencia entre maiúsculas e minúsculas, pode ser tanto "idioma" quanto "Idioma", mas os
valores retornados, principalmente se utilizados com uma instrução Select, diferenciam entre maiúsculas e
minúsculas.

[Link] ProductString
Esta propriedade contém uma String com o nome do produto e a versão do Elipse E3 Viewer, como por exemplo
"Elipse E3 6.8.148". Esta propriedade é somente de leitura.
Note que o Elipse E3 Viewer pode acessar um objeto no Servidor e recuperar a propriedade ProductString daquele
Servidor, conforme o exemplo a seguir.
Set servidor = [Link]("ServidorDados").Application
MsgBox "Versão do Servidor: " & [Link]

No exemplo anterior, considerando-se que o objeto ServidorDados está em um Servidor, o texto mostrado na caixa
de diálogo é "Versão do Servidor: Elipse E3 6.8.148" ou "Versão do Servidor: Elipse E3 (64-bits) 6.8.148".

[Link] ProductVersionBuild
Esta propriedade contém o número de build da versão do Elipse E3 Viewer. Por exemplo, se a versão instalada é a
6.8.148, esta propriedade contém o valor 148. Esta propriedade é somente de leitura.

[Link] ProductVersionMajor
Esta propriedade contém o número principal da versão do Elipse E3 Viewer. Por exemplo, se a versão instalada é a
6.8.148, esta propriedade contém o valor 6. Esta propriedade é somente de leitura.

[Link] ProductVersionMinor
Esta propriedade contém o número secundário da versão do Elipse E3 Viewer. Por exemplo, se a versão instalada é
a 6.8.148, esta propriedade contém o valor 8. Esta propriedade é somente de leitura.

[Link] ReconnectDialogDelaySec
Indica o número de segundos que o Elipse E3 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 o valor
desta propriedade é 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, como por exemplo um bilhão.

Visualização 79
NOTA
Quando a reconexão ocorre em silêncio, todas as janelas do Elipse E3 Viewer ativo são desabilitadas e uma
ampulheta é mostrada, indicando que a aplicação está indisponível. Durante o tempo da reconexão, não é permitido
ao usuário cancelar o processo.

[Link] RenderQuality
Controla a qualidade de desenho de todas as Telas, somente se o valor da propriedade RenderQuality das Telas
é igual a 0 - rqDefault. Os valores possíveis para esta propriedade são:
· 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 Elipse E3 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 Elipse E3 Viewer, em tempo de
execução
· 2 - rqHighQuality: Força o modo de alta qualidade (GDI+) para o desenho de todas as Telas. Corresponde ao
item Forçar Alta Qualidade do menu contextual Qualidade (todas as telas) do Elipse E3 Viewer, em tempo de
execução. Este é o valor padrão para aplicações criadas a partir da versão 4.0

A figura a seguir mostra o menu contextual do Elipse E3 Viewer em tempo de execução, com as respectivas opções
de configuração desta propriedade.

Opções da propriedade RenderQuality do Elipse E3 Viewer

80 Visualização
[Link] ScreenAlignment
Controla o alinhamento, dado pelo Elipse E3 Viewer, para as Telas que não especificam um valor diferente do
padrão. Os valores possíveis para esta propriedade são:
· 1 - paTopLeft: Ajusta a Tela ao canto superior esquerdo em relação à área visível. Corresponde à opção Forçar
Superior Esquerdo do menu contextual Alinhamento (Esta Tela) da Tela, em tempo de execução
· 2 - paCenter: Ajusta a Tela ao centro em relação à área visível. Corresponde à opção Forçar Centralizado do
menu contextual Alinhamento (Esta Tela) da Tela, em tempo de execução

A figura a seguir mostra o menu contextual do Elipse E3 Viewer em tempo de execução, com as respectivas opções
de configuração desta propriedade.

Opções da propriedade ScreenAlignment do Elipse E3 Viewer

[Link] ShowKeyPadOnEdit
Esta propriedade automaticamente habilita a exibição do Elipse KeyPad, sempre que um objeto de Tela que
permita edição receba o foco.

[Link] 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. Esta propriedade não pode ser alterada em
tempo de execução, mesmo que o Elipse E3 Viewer esteja inativo.

Visualização 81
[Link] 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. Esta propriedade não pode ser alterada em
tempo de execução, mesmo que o Elipse E3 Viewer esteja inativo.

[Link] TargetMarginX
Define o número de pixels que devem ser descontados da resolução horizontal da Tela, ou seja, a área útil do Elipse
E3 Viewer. O valor padrão desta propriedade é -1 (menos um), que assume a configuração da janela do Elipse E3
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). Esta propriedade não pode ser alterada em tempo de
execução, mesmo que o Elipse E3 Viewer esteja inativo.

[Link] TargetMarginY
Define o número de pixels que devem ser descontados da resolução vertical da Tela, ou seja, a área útil do Elipse
E3 Viewer. O valor padrão desta propriedade é -1 (menos um), que assume a configuração da janela do Elipse E3
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). Esta propriedade não pode ser alterada em tempo de
execução, mesmo que o Elipse E3 Viewer esteja inativo.

[Link] 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. Esta propriedade não pode ser alterada
em tempo de execução, mesmo que o Elipse E3 Viewer esteja inativo.

[Link] 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. Esta propriedade não pode ser alterada
em tempo de execução, mesmo que o Elipse E3 Viewer esteja inativo.

[Link] TitleBar
Se esta propriedade está habilitada, a barra de título do Elipse E3 Viewer é mostrada, conforme as especificações
da propriedade Caption. Do contrário, a barra de título é escondida. O valor padrão desta propriedade é
Verdadeiro.

[Link] User
Contém o nome do usuário que está utilizando o Elipse E3 Viewer. Esta propriedade é somente de leitura.

[Link] ViewerLanguageId
Retorna o código do idioma do Elipse E3 Viewer em execução. Os valores possíveis para esta propriedade estão
descritos na tabela a seguir. Esta propriedade é somente de leitura.
Valores disponíveis para a propriedade ViewerLanguageId
DECIMAL HEXADECIMAL IDIOMA
4 0x0004 Chinês Simplificado
1031 0x0407 Alemão
1033 0x0409 Inglês Americano
1046 0x0416 Português do Brasil
11274 0x2C0A Espanhol da Argentina

NOTA
Esta propriedade NÃO corresponde ao idioma de instalação do Windows e nem ao idioma configurado no painel
de controle Opções Regionais e de Idioma (Relógio, Idioma e Região no Windows 7) do Windows.

82 Visualização
[Link] WindowBorder
Habilita ou desabilita uma borda na janela do Elipse E3 Viewer. O valor padrão desta propriedade é Verdadeiro.
Esta propriedade é de leitura e escrita, mas alterar o valor em tempo de execução não altera a configuração do
Elipse E3 Viewer já aberto, apenas das janelas que são abertas utilizando a configuração do Elipse E3 Viewer.

[Link] WindowHeight
Determina a altura da janela do Elipse E3 Viewer, em pixels. O valor padrão desta propriedade é 300.

[Link] WindowMovable
Indica se a janela pode ser movida. O valor padrão desta propriedade é Verdadeiro. Esta propriedade é de leitura
e escrita, mas alterar o valor em tempo de execução não altera a configuração do Elipse E3 Viewer já aberto, apenas
das janelas que são abertas utilizando a configuração do Elipse E3 Viewer.

[Link] WindowResizable
Indica se a janela pode ser redimensionada. Esta propriedade só tem efeito se a propriedade WindowBorder é
igual a Verdadeiro. O valor padrão desta propriedade é Verdadeiro. Esta propriedade é de leitura e escrita, mas
alterar o valor em tempo de execução não altera a configuração do Elipse E3 Viewer já aberto, apenas das janelas
que são abertas utilizando a configuração do Elipse E3 Viewer.

[Link] WindowSmallTitle
Indica se a janela do Elipse E3 Viewer deve ter a barra de título pequena. Esta propriedade só tem efeito se a
propriedade TitleBar é igual a Verdadeiro. O valor padrão desta propriedade é Falso. Esta propriedade é de leitura e
escrita, mas alterar o valor em tempo de execução não altera a configuração do Elipse E3 Viewer já aberto, apenas
das janelas que são abertas utilizando a configuração do Elipse E3 Viewer.

[Link] WindowStayOnTop
Indica se a janela do Elipse E3 Viewer deve sempre se sobrepor às outras janelas. O valor padrão desta
propriedade é Falso. Esta propriedade é de leitura e escrita, mas alterar o valor em tempo de execução não altera a
configuração do Elipse E3 Viewer já aberto, apenas das janelas que são abertas utilizando a configuração do Elipse
E3 Viewer.

[Link] WindowStyle
Define o estilo inicial de janela do Elipse E3 Viewer. Os valores possíveis para esta propriedade são 0 -
Maximized: Inicia o Elipse E3 Viewer maximizado (padrão), 1 - Windowed: Inicia o Elipse E3 Viewer janelado ou 2 -
Minimized: Inicia o Elipse E3 Viewer minimizado.

[Link] WindowWidth
Determina a largura da janela do Elipse E3 Viewer, em pixels. O valor padrão desta propriedade é 400.

4.2 Quadros e Divisores

Esta seção contém informações sobre métodos e propriedades do objeto Divisor (FrameSet) e sobre as
propriedades do objeto Quadro (Frame). O objeto Divisor não possui eventos associados e o objeto Quadro não
possui eventos nem métodos associados.

4.2.1 Métodos do Divisor

Esta seção contém informações sobre os métodos do objeto Divisor (FrameSet).

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

Visualização 83
[Link] CaptureScreen
CaptureScreen(Filename)
Captura o conteúdo de um Divisor, gravando-o no arquivo de nome e caminho Filename no formato BMP, conforme o
exemplo a seguir.
Sub CommandButton1_Click()
' Ao clicar neste Botão, copia o conteúdo
' do Divisor para o arquivo [Link]
[Link]("c:\temp\[Link]")
End Sub

[Link] Close
Close(Code)
Utilize este método 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 é chamada por este método, conforme o exemplo a seguir.
Sub BotaoFecha_Click()
' Ao clicar neste Botão, fecha a janela
[Link](0)
End Sub

[Link] FlashWindow
FlashWindow(Number, Time)
Este método permite que o ícone do Elipse E3 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, conforme o exemplo a seguir.
Sub Texto1_Click()
Set quadro = [Link]("_top")
[Link] 50, 500
End Sub

[Link] MaximizeFrame
MaximizeFrame()
Maximiza um Quadro ou Tela modal.

[Link] MinimizeFrame
MinimizeFrame()
Minimiza um Quadro ou Tela modal.

[Link] 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 e, se omitidos, não movem, no caso dos parâmetros PosX e PosY, e nem redimensionam, no caso dos
parâmetros SizeX e SizeY, o Divisor, conforme o exemplo a seguir.
Sub Tela2_OnPreShow(vArg)
' Quando a Tela2 é aberta no Divisor Teste, altera a posição
' e o tamanho do Divisor
[Link]("Teste").MoveFrame 100, 100, 200, 200
End Sub

NOTA
Os valores de tamanho neste método podem ser informados como números ou Strings. No caso de números, são
considerados em pixels. No caso de Strings, se vierem acompanhados da unidade "hm", são interpretados como
Himetric. Qualquer outro caso é considerado em pixels.

84 Visualização
[Link] NavigateBack
NavigateBack()
Volta para a Tela anterior no histórico de navegação do Divisor, se a propriedade NavigateCanGoBack é Verdadeira.

[Link] NavigateForward
NavigateForward()
Avança para a Tela seguinte no histórico de navegação do Divisor, se a propriedade NavigateCanGoForward é
Verdadeira.

[Link] NavigateHistReset
NavigateHistReset()
Limpa o histórico de abertura de Telas do Divisor, indicado pela propriedade NavigateHistCount.

[Link] OpenScreen
OpenScreen(ScreenName, Arg)
Este método abre uma Tela dentro de um Divisor. O parâmetro ScreenName determina a Tela a ser aberta, além de
ser possível especificar algumas propriedades desta Tela. Consulte a propriedade SplitLink do Divisor para mais
informações sobre o formato para especificar uma Tela neste parâmetro. O parâmetro Arg permite especificar um
valor a ser repassado à Tela através do evento OnPreShow, como no exemplo a seguir.
Sub Botao1_Click()
'Clicar neste Botão abre a Tela2 no Frame Teste,
'zoom de 100%, sem barra de rolagem
'e alinhamento padrão em relação à área visível
'Também passa uma String para o evento OnPreShow
[Link]("Teste")._
OpenScreen "Tela2?100?0?0", "Isto é um teste."
End Sub

Sub Tela2_OnPreShow(vArg)
'A caixa de mensagem mostra
'a frase "Isto é um teste."
MsgBox vArg
End Sub

[Link] Refresh
Refresh([Force])
Este método permite forçar o redesenho do conteúdo de uma Tela ou Divisor. Este método deve ser usado em scripts
do Elipse E3 Viewer com processamento massivo, como por exemplo em 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 deste método, sem o parâmetro Force, é
otimizada de forma a ignorar pedidos de redesenho muito próximos, incluindo redesenho do próprio Elipse E3. 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 deste método seja
realizado um redesenho. Porém, ao utilizar-se esta opção, este método não pode ser chamado repetidamente, como
dentro de um laço, conforme o exemplo a seguir.
Sub CommandButton1_Click()
' Desenha uma barra de progresso de uma operação
While i < 31
[Link]("Retangulo2")_
.HorizontalPercentFill = (i / 30) * 100
[Link] True
' <-- alguma operação demorada -->
Wend
End Sub

[Link] RestoreFrame
RestoreFrame()
Permite restaurar a janela do Quadro para o tamanho original.

Visualização 85
[Link] 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 mais de uma instância do Elipse E3 Viewer está executando em um mesmo computador, e pelo menos uma
destas instâncias utiliza este método, a alteração afeta todos os Elipse E3 Viewers deste computador.
· Caso seja necessário modificar o título ou o estilo da janela, o método SetFrameOptions deve ser utilizado após a
chamada a este método.

[Link] SetForegroundWnd
SetForegroundWnd()
Este método ativa e move o foco para a janela do Elipse E3 Viewer, e é útil quando se deseja chamar a atenção do
operador para algum evento ocorrido, quando a janela do Elipse E3 Viewer encontra-se escondida ou minimizada.

[Link] SetFrameOptions
SetFrameOptions(Title, [Flags])
Este método é 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 está vazia.
O parâmetro Flags especifica o estilo da janela. Se este parâmetro é 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 é igual a -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 Habilita a barra de título na janela

2 Habilita o botão Fechar na janela

4 Habilita o botão Minimizar na janela

8 Habilita o botão Maximizar na janela

16 Habilita a borda na janela

32 Especifica que a janela pode ser dimensionada. Para isto,

é necessário que a janela tenha uma borda

64 Especifica que a janela pode ser movida

256 Especifica que a janela fica no topo da Tela

512 Especifica que a janela é configurada no estilo Barra de

Ferramentas

1024 Desabilita os botões de objeto

2048 Centraliza a janela

Exemplo:
Sub Tela_OnPreShow()
[Link]("Tela de Alarmes", 114)
End Sub

No exemplo anterior, o valor 114 (2 + 16 + 32 + 64) indica que a janela tem um botão Fechar habilitado (2), 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, consulte o tópico Picks.

86 Visualização
NOTA
Este método deve ser usado após a chamada ao método SetDisableTaskSwitching, caso seja necessário modificar
o título ou o estilo da janela.

[Link] ShowScreen
ShowScreen(Screen, [Zoom], [Scrollbars], [Arg], [Alignment])
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. Se omitido, assume o valor 100
· Scrollbars: Booleano que indica se a barra de rolagem da Tela deve ou não estar habilitada. Se omitido, não
habilita a barra de rolagem da Tela
· Arg: String cujo valor é usado no evento OnPreShow da Tela a ser carregada. Se omitido, não passa nenhum
valor para a Tela a ser carregada
· Alignment: Indica se a Tela deve ter um alinhamento superior esquerdo (1, um) ou um alinhamento centralizado
(2, dois) em relação à área visível. Se este parâmetro é omitido ou se o valor informado é inválido, assume o
valor 0 (zero, comportamento padrão da Tela)

A propriedade SplitLink é atualizada após a chamada deste método.

NOTA
O parâmetro Screen somente aceita o objeto retornado pelo método GetScreen do Viewer. Este método falha caso
seja utilizado um objeto Tela obtido a partir de outro método ou propriedade, como por exemplo a propriedade
Screen, comum a todos os objetos de Tela.

4.2.2 Propriedades do Divisor

Esta seção contém informações sobre as propriedades do objeto Divisor (FrameSet).

[Link] IsHTML
Esta propriedade retorna Verdadeiro se o Divisor contém código HTML inserido no Quadro ou Falso caso
contrário. Esta propriedade é somente de leitura.

[Link] NavigateCanGoBack
Indica se é possível usar o método NavigateBack no Divisor. Esta propriedade é somente de leitura.

[Link] NavigateCanGoForward
Indica se é possível usar o método NavigateForward no Divisor. Esta propriedade é somente de leitura.

[Link] NavigateHistCount
Informa o número de Telas disponíveis no histórico de navegação do Divisor. Esta propriedade é somente de leitura.
O histórico de navegação de um Divisor tem um limite máximo de aproximadamente 100 Telas. Após atingir este
limite, as Telas mais antigas vão sendo descartadas.

[Link] 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.

Visualização 87
[Link] 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 a propriedade SplitDockPosition
OPÇÃO DESCRIÇÃO
0 - dockRemaining Posiciona o Divisor como restante, ou seja, ocupa o
espaço que sobra na Divisão horizontal ou vertical
(padrão)

1 - dockTop Posiciona o Divisor como mandante, acima do restante

2 - dockBottom Posiciona o Divisor como mandante, abaixo do restante

3 - dockLeft Posiciona o Divisor como mandante, à esquerda do

restante

4 - dockRight Posiciona o Divisor como mandante, à direita do restante

Esta propriedade não pode ser alterada em tempo de execução, mesmo que o Divisor esteja inativo.

[Link] SplitLink
Esta propriedade contém um link que deve ser mostrado no Divisor. Pode-se especificar uma Tela do projeto, um
executável ou um link na Internet. No caso de Telas, é possível especificar um percentual de zoom, habilitar as barras
de rolagem e alinhar a Tela na área visível usando como separador um ponto de interrogação no formato "<nome-
da-tela>?<zoom>?<barra-de-rolagem>?<alinhamento>". Os valores possíveis para os parâmetros desta
propriedade estão descritos a seguir.
· <nome-da-tela>: Este parâmetro é obrigatório e indica o nome de uma Tela, um executável ou um link na
Internet a ser aberto no Divisor
· <zoom>: Este parâmetro é opcional e indica o percentual de zoom da Tela a ser aberta no Divisor. Se este
parâmetro não é informado, assume o valor de 100%
· <barra-de-rolagem>: Este parâmetro é opcional e indica se a Tela deve habilitar (1, um) ou desabilitar (0, zero) a
barra de rolagem. Se este parâmetro não é informado, assume o valor 1 (um, habilitado)
· <alinhamento>: Este parâmetro é opcional e indica se a Tela deve ter um alinhamento superior esquerdo (1, um)
ou um alinhamento centralizado (2, dois) em relação à área visível. Se este parâmetro não é informado ou se o
valor informado é inválido, assume o valor 0 (zero, comportamento padrão da Tela, configurado na propriedade
ScreenAlignment da Tela a ser aberta)

Os parâmetros <zoom>, <barra-de-rolagem> e <alinhamento> são válidos apenas se o parâmetro <nome-da-tela> se

tratar de uma Tela. Do contrário, são ignorados.

[Link] 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.

[Link] SplitValue
Esta propriedade determina o valor que é atribuído ao Divisor de um Quadro. Este valor pode ser acompanhado da
unidade "%" (porcentagem), "hm" (Himetric) ou "px" (pixels). Se a unidade é omitida, o valor é considerado em
unidades Himetric.

4.2.3 Propriedades do Quadro

Esta seção contém informações sobre as propriedades do objeto Quadro (Frame).

[Link] Caption
Esta propriedade define o título do Quadro a ser mostrado na barra de título do Elipse E3 Viewer.

88 Visualização
4.3 Telas e Objetos de Tela
Esta seção contém informações sobre eventos, métodos e propriedades de Telas e Objetos de Tela.

4.3.1 Tela
Esta seção contém informações sobre eventos, métodos e propriedades do objeto Tela (Screen).

[Link] Eventos
Esta seção contém informações sobre os eventos do objeto Tela (Screen).

[Link].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.

[Link].2 DblClick
DblClick()
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.

[Link].3 KeyDown
KeyDown(KeyCode, Shift)
Ocorre no momento em que uma tecla é pressionada, independente do foco na Tela.
Parâmetros do evento KeyDown
NOME DESCRIÇÃO
KeyCode Número inteiro que identifica o caractere ASCII da tecla
pressionada

Shift Mostra o atalho de teclado usado juntamente com a

tecla pressionada. Os valores possíveis para este
parâmetro são 4: Tecla SHIFT, 8: Tecla CTRL ou 12: Teclas
CTRL + SHIFT

O script a seguir contém um exemplo de uso deste evento.

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

NOTA
Para uma lista com todos os códigos de tecla disponíveis para o parâmetro KeyCode, consulte o artigo Keys Enum no
Microsoft Learn.

[Link].4 KeyUp
KeyUp(KeyCode, Shift)
Ocorre no momento em que uma tecla é solta, independente do foco na Tela.

Visualização 89
 Parâmetros do evento KeyUp
NOME DESCRIÇÃO
KeyCode Número inteiro que identifica o caractere ASCII da tecla
pressionada

Shift Mostra o atalho de teclado usado juntamente com a

tecla pressionada. Os valores possíveis para este
parâmetro são 4: Tecla SHIFT, 8: Tecla CTRL ou 12: Teclas
CTRL + SHIFT

O script a seguir contém um exemplo de uso deste evento.

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

NOTA
Para uma lista com todos os códigos de tecla disponíveis para o parâmetro KeyCode, consulte o artigo Keys Enum no
Microsoft Learn.

[Link].5 MouseDown
MouseDown(Button, ShiftState, MouseX, MouseY)
Ocorre quando se pressiona qualquer botão do mouse na Tela. Utilize este evento para determinar ações específicas
quando a Tela é clicada pelo usuário.
Parâmetros do evento MouseDown
NOME DESCRIÇÃO
Button Mostra o botão do mouse pressionado. Os valores
possíveis para este parâmetro são 1: O botão do mouse
pressionado é o esquerdo, 2: O botão do mouse
pressionado é o direito ou 4: O botão do mouse
pressionado é o do meio

ShiftState Mostra a tecla pressionada juntamente com o botão do

mouse. Os valores possíveis para este parâmetro são 4:
Tecla SHIFT, 8: Tecla CTRL ou 12: Teclas CTRL + SHIFT

MouseX Mostra a coordenada X onde o ponteiro do mouse foi

clicado na Tela

MouseY Mostra a coordenada Y onde o ponteiro do mouse foi

clicado na Tela

O script a seguir contém um exemplo de uso deste evento.

Sub TelaInicial_MouseDown(Button, ShiftState, MouseX, MouseY)
' Encerra a aplicação quando houver um clique de mouse
' no objeto TelaInicial.
[Link]()
End Sub

[Link].6 MouseUp
MouseUp(Button, ShiftState, MouseX, MouseY)
Ocorre quando se solta qualquer botão do mouse previamente clicado. Utilize este evento para especificar ações que
são disparadas somente quando o botão do mouse é solto.

90 Visualização
 Parâmetros do evento MouseUp
NOME DESCRIÇÃO
Button Mostra o botão do mouse pressionado. Os valores
possíveis para este parâmetro são 1: O botão do mouse
pressionado é o esquerdo, 2: O botão do mouse
pressionado é o direito ou 4: O botão do mouse
pressionado é o do meio

ShiftState Mostra a tecla pressionada juntamente com o botão do

mouse. Os valores possíveis para este parâmetro são 4:
Tecla SHIFT, 8: Tecla CTRL ou 12: Teclas CTRL + SHIFT

MouseX Mostra a coordenada X onde o ponteiro do mouse foi

clicado na Tela

MouseY Mostra a coordenada Y onde o ponteiro do mouse foi

clicado na Tela

O script a seguir contém um exemplo de uso deste evento.

Sub TelaInicial_MouseUp(Button, ShiftState, MouseX, MouseY)
' Encerra a aplicação apenas quando o usuário soltar o botão.
[Link]()
End Sub

[Link].7 OnHide
OnHide()
Ocorre quando uma Tela está prestes a ser fechada. Utilize este evento quando for necessário efetuar alguma
operação antes do objeto Tela ser fechado. Este evento pode ocorrer de diversas maneiras:
· Quando a Tela é 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 Elipse E3 Viewer é fechado ou encerrado

[Link].8 OnPreShow
OnPreShow(Arg)
Ocorre antes da Tela ser mostrada. O parâmetro 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. O script a seguir contém um exemplo
de uso deste evento.
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

[Link].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. O script a seguir contém um exemplo de uso deste evento.
Sub TelaPrincipal_OnShow()
MsgBox "Seja bem-vindo ao sistema!"
End Sub

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Tela (Screen).

Visualização 91
[Link].1 Close
Close(Code)
Utilize este método 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 é chamada por este método.
O script a seguir contém um exemplo de uso deste método.
Sub BotaoFecha_Click()
' Ao clicar em BotaoFecha, fecha a janela
[Link](0)
End Sub

[Link].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.

[Link].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.

[Link].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.

[Link].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.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Tela (Screen).

NOTA
O Elipse E3 utiliza para definição de coordenadas e espessura o sistema Himetric. Neste sistema, cada unidade
lógica equivale a um milésimo de centímetro; ou seja, cada 1000 unidades equivalem a 1 centímetro. Assim, este é o
padrão adotado na descrição das propriedades do Elipse E3, quando aplicável.

[Link].1 AllowContextMenu
Se configurada em Verdadeiro, esta propriedade habilita a exibição do menu contextual de uma Tela através do
botão direito do mouse em tempo de execução, exceto quando algum script está configurado com informação
divergente nos eventos MouseDown ou MouseUp. Caso contrário, o menu contextual não é mostrado. O valor
padrão desta propriedade é Verdadeiro.

[Link].2 AllowZoomChange
Esta propriedade habilita a exibição ou não das opções de alteração do nível de zoom no menu contextual de uma
Tela. O valor padrão desta propriedade é Verdadeiro.

[Link].3 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)).

92 Visualização
[Link].4 Caption
Esta propriedade define o título da Tela a ser mostrado na barra de título do Elipse E3 Viewer.

[Link].5 FillStyle
Esta propriedade especifica o estilo do preenchimento da Tela. A tabela a seguir contém os valores válidos para
esta propriedade.
Opções disponíveis para a propriedade FillStyle
OPÇÃO DESCRIÇÃO
0 - Solid O preenchimento é sólido (padrão)

2 - Horizontal O preenchimento é com listras horizontais

3 - Vertical O preenchimento é com listras verticais

4 - Downward O preenchimento é com listras descendo da esquerda

para a direita em ângulo de 45 graus

5 - Upward O preenchimento é com listras subindo da esquerda

para a direita em ângulo de 45 graus

6 - Cross O preenchimento é com listras horizontais e verticais

7 - DiagonalCross O preenchimento é com listras descendo e subindo da

esquerda para a direita em ângulo de 45 graus

8 - Gradient O preenchimento é em degradê utilizando tanto

ForegroundColor quanto BackgroundColor. O efeito é
definido pela propriedade GradientStyle

11 - Background Preenche a Tela com a cor definida na propriedade

BackgroundColor

12 - Picture Preenche a Tela com a figura selecionada na

propriedade PictureFile

[Link].6 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 desta propriedade é preto (RGB(0, 0, 0)). Aplicações
anteriores à introdução desta propriedade têm esta propriedade e a propriedade BackgroundColor configuradas
com a cor antes armazenada na propriedade BackgroundColor, e o estilo de preenchimento é configurado com o
valor 11 - Background, que pinta toda a Tela com a cor de fundo, ou seja, o comportamento antigo, anterior à
criação dos estilos. O script a seguir contém um exemplo de uso desta propriedade.
Sub Tela1_Click()
' Troca a cor de fundo da Tela para azul
ForegroundColor = RGB(0, 0, 255)
End Sub

[Link].7 GradientStyle
Esta propriedade especifica o estilo de preenchimento degradê de uma Tela. Esta propriedade só é utilizada
quando o valor da propriedade FillStyle está 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 a propriedade GradientStyle
OPÇÃO DESCRIÇÃO
0 - LeftToRight Degradê vertical da esquerda para a direita (padrão)

1 - RightToLeft Degradê vertical da direita para a esquerda

2 - VertToCenter Degradê vertical das bordas para o centro

3 - VertFromCenter Degradê vertical do centro para as bordas

4 - TopDown Degradê horizontal de cima para baixo

Visualização 93
 OPÇÃO DESCRIÇÃO
5 - BottomUp Degradê horizontal de baixo para cima

6 - HorzToCenter Degradê das bordas para o centro

7 - HorzFromCenter Degradê do centro para as bordas

8 - DiagDownRight Degradê diagonal para baixo com cor de frente na

direita

9 - DiagUpLeft Degradê diagonal para cima com a cor de frente na

esquerda

10 - DiagUpToCenter Degradê diagonal para cima das bordas para o centro

11 - DiagUpFromCenter Degradê diagonal para cima do centro para as bordas

12 - DiagDownLeft Degradê diagonal para baixo com cor de frente na

esquerda

13 - DiagUpRight Degradê diagonal para cima com a cor de frente na

direita

14 - DiagDownToCenter Degradê diagonal para baixo das bordas para o centro

15 - DiagDownFromCenter Degradê diagonal para baixo do centro para as bordas

16 - SpotBottomRight Degradê com cor de frente partindo do canto inferior

direito

17 - SpotBottomLeft Degradê com cor de frente partindo do canto inferior

esquerdo

18 - SpotTopLeft Degradê com cor de frente partindo do canto superior

esquerdo

19 - SpotTopRight Degradê com cor de frente partindo do canto superior

direito

20 - SpotFromCenter Degradê com cor de fundo do centro para as bordas

21 - SpotToCenter Degradê com cor de fundo das bordas para o centro

[Link].8 Layer
Esta propriedade define, para a Tela, quais camadas estão visíveis. Para os objetos de Tela, esta propriedade define
se aquele objeto de Tela está visível naquela camada. O valor desta propriedade 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 desta propriedade.

94 Visualização
 Opções da propriedade Layer

NOTA
A visibilidade de um objeto de Tela depende dos seguintes fatores: A propriedade Visible tem de estar configurada
para Verdadeiro, o objeto pai tem de estar visível e esta propriedade tem de estar habilitada para a Tela.

[Link].9 PictureFile
Contém o nome do arquivo da figura que é utilizada como fundo da Tela. Pode ser qualquer formato já suportado
no Elipse E3 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 está selecionada com
o valor 12 - Picture.

[Link].10 PicturePosition
Indica a posição da figura selecionada na propriedade PictureFile na Tela. Esta propriedade só é válida se a
propriedade FillStyle está selecionada com o valor 12 - Picture. As opções válidas estão descritas na tabela a seguir.
Opções disponíveis para a propriedade PicturePosition
OPÇÃO DESCRIÇÃO
0 - Center Figura no tamanho original, centralizada na Tela (padrão)

1 - Tile Figura no tamanho original, repetida tantas vezes

quantas forem necessárias para preencher a Tela

2 - Stretch Figura redimensionada para preencher a Tela

3 - TopLeft Figura no tamanho original, no canto esquerdo superior

da Tela

4 - BottomLeft Figura no tamanho original, no canto esquerdo inferior

da Tela

5 - BottomRight Figura no tamanho original, no canto direito inferior da

Tela

6 - TopRight Figura no tamanho original, no canto direito superior da

Tela

Visualização 95
[Link].11 RenderQuality
Controla a qualidade do desenho de uma Tela. Os valores possíveis para esta propriedade são os seguintes:
· 0 - rqDefault: A qualidade do 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, Graphics Device Interface) 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.

Opções da propriedade RenderQuality da Tela

[Link].12 ScreenAlignment
Controla o alinhamento da Tela em relação à area visível. Os valores possíveis para esta propriedade são os
seguintes:
· 0 - paDefault: Ajusta a Tela a seguir o valor definido pela propriedade ScreenAlignment do Viewer.
Corresponde à opção Utilizar Padrão do menu contextual Alinhamento (Esta Tela) da Tela, em tempo de
execução
· 1 - paTopLeft: Ajusta a Tela ao canto superior esquerdo em relação à área visível. Corresponde à opção Forçar
Superior Esquerdo do menu contextual Alinhamento (Esta Tela) da Tela, em tempo de execução

96 Visualização
 · 2 - paCenter: Ajusta a Tela ao centro em relação à área visível. Corresponde à opção Forçar Centralizado do
menu contextual Alinhamento (Esta Tela) da Tela, em tempo de execução

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.

Opções da propriedade ScreenAlignment da Tela

4.3.2 Objetos de Tela

Esta seção contém informações sobre eventos, métodos e propriedades dos Objetos de Tela.

[Link] Eventos Comuns

Esta seção contém informações sobre os eventos comuns a todos os Objetos de Tela.

[Link].1 Click
Click()
Ocorre quando o botão esquerdo do mouse é pressionado sobre um objeto. Este evento não ocorre se o objeto não
está visível ou se a propriedade Enabled está configurada para Falso. A visibilidade de um 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.

Visualização 97
[Link].2 DblClick
DblClick()
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 está visível ou se a propriedade Enabled está 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.

[Link].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 está habilitado, ou seja, a propriedade Enabled igual a Falso, ou este objeto não
possui o foco do teclado.
Parâmetros do evento KeyDown
NOME DESCRIÇÃO
KeyCode Número inteiro que identifica o caractere ASCII da tecla
pressionada

Shift Mostra o atalho de teclado usado juntamente com a

tecla pressionada. Os valores possíveis são 4: Tecla
SHIFT, 8: Tecla CTRL ou 12: Teclas CTRL + SHIFT

NOTA
Para uma lista com todos os códigos de tecla disponíveis para o parâmetro KeyCode, consulte o artigo Keys Enum no
Microsoft Learn.

[Link].4 KeyUp
KeyUp(KeyCode, Shift)
Ocorre no momento em que uma tecla é solta e o objeto está com o foco do teclado. Note que este evento não é
gerado se o objeto não está habilitado, ou seja, propriedade Enabled igual a Falso, ou se este objeto não possui o
foco do teclado.
Parâmetros do evento KeyUp
NOME DESCRIÇÃO
KeyCode Número inteiro que identifica o caractere ASCII da tecla
pressionada

Shift Mostra o atalho de teclado usado juntamente com a

tecla pressionada. Os valores possíveis são 4: Tecla
SHIFT, 8: Tecla CTRL ou 12: Teclas CTRL + SHIFT

NOTA
Para uma lista com todos os códigos de tecla disponíveis para o parâmetro KeyCode, consulte o artigo Keys Enum no
Microsoft Learn.

[Link].5 MouseDown
MouseDown(Button, ShiftState, MouseX, MouseY)
Ocorre quando se pressiona qualquer botão do mouse sobre um objeto.
Parâmetros do evento MouseDown
NOME DESCRIÇÃO
Button Mostra o botão do mouse pressionado. Os valores
possíveis são 1: O botão do mouse pressionado é o
esquerdo, 2: O botão do mouse pressionado é o direito
ou 4: O botão do mouse pressionado é o do meio

98 Visualização
 NOME DESCRIÇÃO
ShiftState Mostra a tecla pressionada juntamente com o botão do
mouse. Os valores possíveis são 4: Tecla SHIFT, 8: Tecla
CTRL ou 12: Teclas CTRL + SHIFT

MouseX Mostra a coordenada horizontal onde o botão do mouse

foi clicado na Tela

MouseY Mostra a coordenada vertical onde o botão do mouse

foi clicado na Tela

[Link].6 MouseUp
MouseUp(Button, ShiftState, MouseX, MouseY)
Ocorre quando se solta qualquer botão do mouse previamente clicado sobre um objeto. Utilize este evento para
especificar ações que são disparadas somente quando o botão do mouse é solto.
Parâmetros do evento MouseUp
NOME DESCRIÇÃO
Button Mostra o botão do mouse pressionado. Os valores
possíveis são 1: O botão do mouse pressionado é o
esquerdo, 2: O botão do mouse pressionado é o direito
ou 4: O botão do mouse pressionado é o do meio

ShiftState Mostra a tecla pressionada juntamente com o botão do

mouse. Os valores possíveis são 4: Tecla SHIFT, 8: Tecla
CTRL ou 12: Teclas CTRL + SHIFT

MouseX Mostra a coordenada horizontal onde o botão do mouse

foi clicado na Tela

MouseY Mostra a coordenada vertical onde o botão do mouse

foi clicado na Tela

[Link] Métodos Comuns

Esta seção contém informações sobre os métodos comuns a todos os Objetos de Tela.

[Link].1 BringToFront
BringToFront()
Posiciona um objeto à frente de todos os outros objetos da Tela.

[Link].2 FitObject
FitObject([ScreenFillPercentage])
Este método enquadra um objeto no centro da Tela usando uma porcentagem relativa à Tela para preenchimento. O
parâmetro ScreenFillPercentage é opcional e, se não é informado, assume o valor 50, ou seja, o objeto ocupa 50% da
área da Tela. Os valores permitidos para este parâmetro variam entre 1 (um) e 100. Este método retorna erro nos
seguintes casos:
· O modo de alinhamento configurado na propriedade ScreenAlignment da Tela onde o objeto está inserido é
diferente de paCenter
· O objeto não está visível, ou seja, a propriedade Visible é igual a Falso
· As coordenadas X e Y do centro do objeto não estão contidas na área da Tela onde o objeto está inserido

[Link].3 SendToBack
SendToBack()
Posiciona um objeto atrás de todos os outros objetos da Tela.

Visualização 99
[Link].4 SetFocus
SetFocus()
Move o foco do ponteiro do mouse ou do teclado para um objeto determinado.

[Link] Propriedades Comuns

Esta seção contém informações sobre as propriedades comuns a todos os objetos de Tela. As propriedades
explicadas a seguir não se aplicam aos objetos MSForms, E3Chart, E3Browser e E3Alarm. Estes são descritos
posteriormente, em capítulos específicos para estes objetos.

NOTAS
· O Elipse E3 utiliza para definição de coordenadas e espessura o sistema Himetric. Neste sistema, cada unidade
lógica equivale a um milésimo de centímetro, ou seja, cada 1000 unidades equivalem a um centímetro. Assim, este
é o padrão adotado na descrição das propriedades do Elipse E3, quando aplicável.
· As propriedades listadas a seguir são comuns a todos os objetos citados anteriormente, inclusive o Grupo de
objetos e movimentos de Rotação e Translação.

[Link].1 Angle
Esta propriedade define o ângulo de rotação em graus, no sentido anti-horário, que um 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 centro, que pode ser editado durante a operação de rotação. O
valor padrão desta propriedade é 0 (zero, sem rotação).

[Link].2 BackgroundColor
Esta propriedade especifica a cor de preenchimento do fundo de um objeto. Esta cor é utilizada quando a
propriedade BackgroundStyle está configurada para 1 (um, opaco) e umas das propriedades VerticalPercentFill ou
HorizontalPercentFill está com valores diferentes de 100. Outro uso desta cor é quando a propriedade FillStyle está
configurada entre os valores 2 (dois) e 8 (oito). Isto permite que a área restante utilize a cor de fundo para
preenchimento. 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)).

[Link].3 BackgroundStyle
Esta propriedade especifica o modo do preenchimento do fundo de um 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
configurada na propriedade BackgroundColor para preenchimento. A tabela a seguir contém os valores válidos para
esta propriedade.
Opções disponíveis para a propriedade BackgroundStyle
OPÇÃO DESCRIÇÃO
0 - Transparent Nenhum fundo deste objeto é desenhado

1 - Opaque Caso visível, o fundo é desenhado (padrão)

[Link].4 BorderColor
Especifica a cor da borda ou a cor da linha de um objeto. Esta propriedade só é utilizada quando a propriedade
BorderStyle não está configurada para o valor 5 (cinco, Null), onde o objeto permanece sem borda. 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 é branco (RGB(255, 255, 255)), exceto para os objetos Display e SetPoint, cujo valor padrão desta
propriedade é cinza escuro (RGB(128,128,128)).

[Link].5 BorderStyle
Esta propriedade determina o estilo de borda que é aplicada a um objeto. As opções disponíveis para esta
propriedade estão descritas na tabela a seguir.

100 Visualização
 Opções disponíveis para a propriedade BorderStyle
OPÇÃO DESCRIÇÃO
0 - Normal Aplica uma borda sólida ao objeto (padrão)

1 - Dash Aplica uma borda com linha tracejada ao objeto

2 - Dot Aplica uma borda pontilhada ao objeto

3 - DashDot Aplica uma borda com traço-ponto ao objeto

4 - DashDotDot Aplica uma borda com traço-ponto-ponto ao objeto

5 - Null O objeto não tem uma borda

[Link].6 BorderWidth
Define a espessura, em unidades Himetric, da linha ou da borda de um objeto. Só é utilizada se a propriedade
BorderStyle não está configurada para o valor 5 (Null). O valor padrão desta propriedade é 0 (zero). Esta é uma
exceção no sistema de medidas do Elipse E3, pois quando o valor é 0 (zero), a espessura da linha ou da borda não é
definida em unidades Himetric, mas sim em pixels. Configurar esta propriedade com o valor 0 (zero) indica a
espessura de um pixel.

[Link].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 a propriedade Effect3D
OPÇÃO DESCRIÇÃO
0 - No3D Transparente (padrão)

1 - Raised Aplica um efeito 3D em alto relevo

2 - Sunken Aplica um efeito 3D em baixo relevo

[Link].8 Effect3D_X
Especifica a dimensão do efeito 3D no eixo horizontal de um objeto (eixo X). O valor padrão desta propriedade é
30.

[Link].9 Effect3D_Y
Especifica a dimensão do efeito 3D no eixo vertical de um objeto (eixo Y). O valor padrão desta propriedade é 30.

[Link].10 Effect3DColorBase
Determina a cor da base do efeito 3D em um objeto. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).

[Link].11 Effect3DColorTop
Determina a cor do topo do efeito 3D em um objeto. O valor padrão desta propriedade é branco (RGB(255, 255,
255)).

[Link].12 Enabled
Habilita ou desabilita um objeto, isto é, o foco e a resposta aos eventos gerados pelo usuário. Se esta propriedade
está 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 atalhos de teclado e o objeto aparece esmaecido. Além disto, se o objeto exibir
um bitmap, este bitmap permanece esmaecido sempre que este objeto está desabilitado.
Esta propriedade e a propriedade 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 esta
propriedade e a propriedade Locked estão ambas configuradas em Verdadeiro, um objeto pode receber foco e
aparecer normalmente na Tela, e os dados podem ser copiados mas não editados. Quando esta propriedade é igual
a Verdadeiro, mas a propriedade Locked é igual a Falso, os dados podem ser não só copiados mas também
editados. No entanto, quando esta propriedade é igual a Falso, o objeto não recebe foco e permanece esmaecido na

Visualização 101
Tela, independente do status da propriedade Locked. Além disto, os dados não podem ser copiados nem tampouco
editados.
É possível combinar as configurações desta propriedade e da propriedade 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 como Falso significa que o Botão de Comando não aparece na ordem de tabulação.
Entretanto, se esta propriedade é igual a Verdadeiro, o usuário ainda pode clicar no Botão de Comando, desde que a
propriedade TakeFocusOnClick esteja definida como Verdadeiro.

NOTA
Configurar esta propriedade no objeto Texto, Display e SetPoint para Falso em tempo de execução cancela a
edição corrente e descarta o conteúdo daquele objeto.

[Link].13 FillStyle
Esta propriedade especifica o estilo do preenchimento dos objetos de Tela. A tabela a seguir contém os valores
válidos para esta propriedade.
Opções disponíveis para a propriedade FillStyle
OPÇÃO DESCRIÇÃO
0 - Solid O preenchimento é sólido (padrão)

1 - Hollow Não há preenchimento

2 - Horizontal O preenchimento é com listras horizontais

3 - Vertical O preenchimento é com listras verticais

4 - Downward O preenchimento é com listras descendo da esquerda

para a direita em ângulo de 45 graus

5 - Upward O preenchimento é com listras subindo da esquerda

para a direita em ângulo de 45 graus

6 - Cross O preenchimento é com listras horizontais e verticais

7 - DiagonalCross O preenchimento é com listras descendo e subindo da

esquerda para a direita em ângulo de 45 graus

8 - Gradient O preenchimento é em degradê utilizando tanto o valor

da propriedade ForegroundColor quanto o valor da
propriedade BackgroundColor. O efeito é definido pela
propriedade GradientStyle

9 - SemiTransparent Deixa o objeto de Tela translúcido

10 - MouseArea Não há preenchimento, mas o objeto de Tela continua

sensível aos eventos

11 - Background Preenche o objeto de Tela com a cor definida na

propriedade BackgroundColor

NOTA
Esta propriedade não está disponível para os objetos Figura, Animação com Translação e Animação com Rotação.

[Link].14 FlipHorizontal
Indica se um objeto de Tela está espelhado em relação ao eixo horizontal. O valor padrão desta propriedade é
Falso.

[Link].15 FlipVertical
Indica se um objeto de Tela está espelhado em relação ao eixo vertical. O valor padrão desta propriedade é Falso.

102 Visualização
[Link].16 ForegroundColor
Esta propriedade especifica a cor do preenchimento da frente de um objeto. Esta cor é utilizada quando a
propriedade FillStyle está configurada para 0 (zero, sólido) ou entre 2 (dois) e 9 (nove). 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 é azul
(RGB(0, 0, 255)), exceto para os objetos Display e SetPoint, cujo valor padrão para esta propriedade é branco
(RGB(255, 255, 255)).

[Link].17 Frame
Retorna o Quadro pai de um objeto. Esta propriedade é somente de leitura.

[Link].18 GradientStyle
Esta propriedade especifica o estilo de preenchimento degradê de um objeto de Tela. Esta propriedade só é
utilizada quando o valor da propriedade FillStyle está 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. Os valores possíveis para esta propriedade são os mesmos descritos na propriedade
GradientStyle da Tela.

IMPORTANTE
Um grande número de objetos mostrados com degradê, simultaneamente, acarretam uma perda de performance na
atualização da Tela. O uso de figuras no lugar pode resolver o problema.

NOTA
Esta propriedade não está disponível para os objetos Figura, Animação com Translação e Animação com Rotação.

[Link].19 HasFocus
Esta propriedade determina que o objeto selecionado tem o foco. Esta propriedade é somente de leitura.

[Link].20 Height
Determina a altura de um objeto.

[Link].21 HorizontalFillStyle
Define como é o preenchimento horizontal de um objeto. Esta propriedade trabalha em conjunto com a
propriedade HorizontalPercentFill, que informa qual porcentagem de um 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 a propriedade HorizontalFillStyle
OPÇÃO DESCRIÇÃO
0 - FillLeftToRight A porcentagem de preenchimento é da esquerda para a
direita (padrão)

1 - FillRightToLeft A porcentagem de preenchimento é da direita para a

esquerda

2 - FillCenterToEdgesH A porcentagem de preenchimento é do centro para as

bordas

[Link].22 HorizontalPercentFill
Utilize esta propriedade para especificar qual a porcentagem da área horizontal de um objeto deve ser preenchida.
Os valores aceitos por esta 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.

Visualização 103
[Link].23 MouseOver
Esta propriedade informa se o ponteiro do mouse encontra-se sobre a Tela. Caso afirmativo, esta propriedade é
habilitada. Do contrário, é desabilitada. Esta propriedade é somente de leitura. O valor padrão desta propriedade é
Falso.

[Link].24 MouseOverChild
Esta propriedade informa se o ponteiro do mouse encontra-se sobre um dos objetos inseridos na Tela. Caso
afirmativo, esta propriedade é habilitada. Do contrário, é desabilitada. Esta propriedade é somente de leitura. O valor
padrão desta propriedade é Falso.

[Link].25 Screen
Retorna a Tela pai de um objeto. Esta propriedade é somente de leitura.

[Link].26 Shadow
Indica a presença do efeito de sombra em um 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.

[Link].27 ShadowColor
Especifica a cor do preenchimento da sombra de um objeto. Esta cor é utilizada quando a propriedade Shadow
está configurada para Verdadeiro. 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 escuro (RGB(128, 128, 128)).

[Link].28 ShadowX
Define a coordenada vertical à esquerda da sombra de um objeto, em unidades Himetric. Esta sombra é sempre
relativa à propriedade X do objeto. Valores positivos indicam que a sombra está à direita do objeto, e negativos à
esquerda. O valor padrão desta propriedade é 200.

[Link].29 ShadowY
Define a coordenada horizontal superior da sombra de um objeto, em unidades Himetric. Esta sombra é sempre
relativa à propriedade Y do objeto. Valores positivos indicam que a sombra está abaixo do objeto, e negativos acima.
O valor padrão desta propriedade é 200.

[Link].30 TabStop
Esta propriedade determina a utilização da tecla TAB na aplicação. Se esta propriedade está configurada em
Verdadeiro, é possível utilizar a tecla TAB. Caso contrário, esta tecla não pode ser utilizada.

[Link].31 Tip
Esta propriedade mostra um texto pop-up quando o ponteiro do mouse permanece por um breve momento sobre
o objeto em tempo de execução.

[Link].32 VerticalFillStyle
Define como é o preenchimento vertical de um 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 a propriedade VerticalFillStyle
OPÇÃO DESCRIÇÃO
0 - FillBottomToTop A porcentagem de preenchimento é de baixo para cima
(padrão)

1 - FillTopToBottom A porcentagem de preenchimento é de cima para baixo

2 - FillCenterToEdgesV A porcentagem de preenchimento é do centro para as

bordas

104 Visualização
[Link].33 VerticalPercentFill
Utilize esta propriedade para especificar qual a porcentagem da área vertical de um objeto deve ser preenchida. Os
valores aceitos por esta propriedade variam de 0 (zero) a 100. Esta propriedade trabalha em conjunto com a
propriedade VerticalFillStyle, que informa como este preenchimento ocorre. O valor padrão desta propriedade é
100.

[Link].34 Visible
Esta propriedade define a visibilidade de um objeto. Se esta propriedade está 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.

[Link].35 Width
Determina a largura de um objeto, em unidades Himetric.

[Link].36 X
Esta propriedade define a coordenada horizontal esquerda, em unidades Himetric, de um objeto.

[Link].37 Y
Esta propriedade define a coordenada vertical superior, em unidades Himetric, de um objeto.

[Link] Animação com Rotação

Esta seção contém informações sobre propriedades do objeto Animação com Rotação (DynamicRotate). Este objeto
não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Animação com Rotação (DynamicRotate).

[Link].1.1 Detents
Esta propriedade determina o número de passos do movimento deste objeto.

[Link].1.2 EnableOverrideLineColor
Esta propriedade habilita ou desabilita este objeto a sobrescrever a cor original da linha da imagem pela cor
definida na propriedade OverrideLineColor. Se esta propriedade está habilitada, isto permite que seja modificada a
cor original da linha deste objeto pela cor da propriedade OverrideLineColor. Caso contrário, este objeto exibe a cor
original. O valor padrão desta propriedade é Falso.

[Link].1.3 EnableSlider
Esta propriedade habilita o slider no movimento deste objeto.

[Link].1.4 OverrideFillColor
Quando a propriedade OverrideFillMode é configurada com os valores 2 (dois) ou 3 (três), esta propriedade é
usada para definir a cor a ser usada no preenchimento dos objetos no movimento, 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)).

[Link].1.5 OverrideFillMode
Esta propriedade especifica o modo do preenchimento dos objetos que estão em movimento e altera o modo
original de preenchimento da imagem, sem alterar a configuração original de preenchimento dos objetos. Os valores
possíveis para esta propriedade estão descritos na tabela a seguir.
Opções disponíveis para a propriedade OverrideFillMode
OPÇÃO DESCRIÇÃO
0 - NoOverride Preenchimento original dos objetos (padrão)

Visualização 105
 OPÇÃO DESCRIÇÃO
1 - Wireframe Os objetos não são preenchidos, desenham somente as
bordas

2 - SolidFill O preenchimento dos objetos contidos no grupo é

sólido com a cor especificada na propriedade
OverrideFillColor

3 - ByBrightness O preenchimento dos objetos contidos no grupo é

sólido com a cor especificada pela propriedade
OverrideFillColor, porém leva em conta qual era a
intensidade da cor original de preenchimento de cada
objeto

[Link].1.6 OverrideLineColor
Quando a propriedade EnableOverrideLineColor está configurada para Verdadeiro, esta propriedade é usada
para definir a cor a ser usada na cor da linha dos objetos em movimento, 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)).

[Link].1.7 RangeMax
Esta propriedade determina o alcance máximo do movimento rotacional deste objeto.

[Link].1.8 RangeMin
Esta propriedade determina o alcance mínimo do movimento rotacional deste objeto.

[Link].1.9 RotationAngle
Esta propriedade determina o ângulo de rotação do movimento deste objeto.

[Link].1.10 RotationDirection
Esta propriedade determina a direção do ângulo de rotação do movimento deste objeto. Os valores possíveis
para esta propriedade estão descritos na tabela a seguir.
Opções disponíveis para a propriedade RotationDirection
OPÇÃO DESCRIÇÃO
0 - Clockwise Direciona o ângulo de rotação à direita deste objeto
(padrão)

1 - Counterclockwise Direciona o ângulo de rotação à esquerda deste objeto

[Link].1.11 Value
Indica o valor inicial do movimento. Deve ser um valor entre os valores definidos nas propriedades RangeMax e
RangeMin.

[Link] Animação com Translação

Esta seção contém informações sobre propriedades do objeto Animação com Translação (DynamicMove). Este objeto
não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Animar com Translação (DynamicMove).

[Link].1.1 Detents
Esta propriedade determina o número de passos do movimento deste objeto.

[Link].1.2 EnableOverrideLineColor
Esta propriedade habilita ou desabilita este objeto a sobrescrever a cor original da linha da imagem pela cor
definida na propriedade OverrideLineColor. Se esta propriedade está habilitada, isto permite que seja modificada a

106 Visualização
cor original da linha deste objeto pela cor definida na propriedade OverrideLineColor. Caso contrário, este objeto
exibe a cor original. O valor padrão desta propriedade é Falso.

[Link].1.3 EnableSlider
Esta propriedade habilita o slider no movimento deste objeto.

[Link].1.4 OverrideFillColor
Quando a propriedade OverrideFillMode é configurada com os valores 2 (dois) ou 3 (três), esta propriedade é
usada para definir a cor a ser usada no preenchimento dos objetos no movimento, 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)).

[Link].1.5 OverrideFillMode
Esta propriedade especifica o modo do preenchimento dos objetos que estão em movimento e altera o modo
original de preenchimento da imagem, sem alterar a configuração original de preenchimento dos objetos. Os valores
possíveis para esta propriedade estão descritos na tabela a seguir.
Opções disponíveis para a propriedade OverrideFillMode
OPÇÃO DESCRIÇÃO
0 - NoOverride Preenchimento original dos objetos (padrão)

1 - Wireframe Os objetos não são preenchidos, desenham somente as

bordas

2 - SolidFill O preenchimento dos objetos contidos no grupo é

sólido com a cor especificada na propriedade
OverrideFillColor

3 - ByBrightness O preenchimento dos objetos contidos no grupo é

sólido com a cor especificada pela propriedade
OverrideFillColor, porém leva em conta qual era a
intensidade da cor original de preenchimento de cada
objeto

[Link].1.6 OverrideLineColor
Quando a propriedade EnableOverrideLineColor está configurada para Verdadeiro, esta propriedade é usada
para definir a cor a ser usada na cor da linha dos objetos em movimento, 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)).

[Link].1.7 RangeMax
Esta propriedade determina o alcance máximo do movimento linear deste objeto.

[Link].1.8 RangeMin
Esta propriedade determina o alcance mínimo do movimento linear deste objeto.

[Link].1.9 Value
Indica o valor inicial do movimento. Deve ser um valor entre os valores definidos nas propriedades RangeMax e
RangeMin.

[Link] Arco de Elipse

Esta seção contém informações sobre propriedades do objeto Arco de Elipse (DrawArc). Este objeto não possui
eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Arco de Elipse (DrawArc).

Visualização 107
[Link].1.1 ArcBeginAngle
Esta propriedade configura o ângulo inicial do arco do objeto, em graus. O intervalo aceito por esta propriedade
vai de 0 (zero) até 359. O estilo e forma do arco dependem também das configurações das propriedades
ArcEndAngle e ArcStyle. O valor padrão desta propriedade é 0 (zero). O script a seguir contém um exemplo de uso
desta propriedade.
Sub CommandButton9_Click()
[Link]("Arco1").ArcBeginAngle = 12
End Sub

[Link].1.2 ArcEndAngle
Esta propriedade configura o ângulo final do arco do objeto, em graus. O intervalo aceito por esta propriedade vai
de 0 (zero) até 359. O estilo e forma do arco dependem também das configurações das propriedades ArcBeginAngle
e ArcStyle. O valor padrão desta propriedade é 270. O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton9_Click()
[Link]("Arco1").ArcEndAngle = 12
End Sub

[Link].1.3 ArcStyle
Esta propriedade especifica o estilo da borda ou linha do objeto. A borda do objeto é desenhada conforme o
estilo definido, utilizando a cor especificada na propriedade BorderColor com a espessura especificada na
propriedade BorderWidth. A tabela a seguir contém os valores válidos para esta propriedade.
Opções disponíveis para a propriedade ArcStyle
OPÇÃO DESCRIÇÃO
0 - arc O estilo do desenho é um arco

1 - chord O estilo do desenho é uma corda, unindo o ponto inicial

e final

2 - pie O estilo do desenho é uma pizza (padrão)

O script a seguir contém um exemplo de uso desta propriedade.

Sub CommandButton9_Click()
[Link]("Arco1").ArcStyle = 1
End Sub

[Link] Conector
Esta seção contém informações sobre propriedades do objeto Conector (DrawConnector). Este objeto não possui
eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Conector (DrawConnector).

[Link].1.1 Points
Retorna o objeto Coleção de Pontos de Conexão dentro do Conector. O objeto Coleção de Pontos de Conexão é
utilizado para inserir, remover ou acessar os Pontos de Conexão disponíveis no Conector. Esta propriedade é
somente de leitura.

[Link].2 Coleção de Pontos de Conexão

Esta seção contém informações sobre métodos e propriedades do objeto Coleção de Pontos de Conexão
(DrawConnectorPoints). Este objeto não possui eventos associados.

[Link].2.1 Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Pontos de Conexão (DrawConnectorPoints).

108 Visualização
AddPoint
AddPoint(X, Y, [IndexAt])
Adiciona um Ponto de Conexão na Coleção de Pontos de Conexão e retorna este objeto. O objeto é inserido nas
coordenadas especificadas pelos parâmetros X e Y e no índice especificado pelo parâmetro IndexAt. Se este
parâmetro é omitido ou é igual a -1 (menos um), o Ponto de Conexão é adicionado ao final da sequência de Pontos
de Conexão. Caso contrário, o valor deste parâmetro deve ser um número entre 1 (um) e o valor da propriedade
Count menos um.
DeletePoint
DeletePoint(NameIndex)
Remove o Ponto de Conexão indicado pelo parâmetro NameIndex, que pode ser tanto o índice quanto o nome deste
Ponto de Conexão na Coleção de Pontos de Conexão. Só é possível remover Pontos de Conexão de uma Coleção de
Pontos de Conexão com mais de dois Pontos de Conexão.
Item
Item(NameIndex)
Retorna um objeto Ponto de Conexão indicado pelo parâmetro NameIndex, que tanto pode ser o índice quanto o
nome deste Ponto de Conexão na Coleção de Pontos de Conexão.

[Link].2.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Pontos de Conexão
(DrawConnectorPoints).
Count
Contém o número de Pontos de Conexão na Coleção. Esta propriedade é somente de leitura.

[Link].2.3 Ponto de Conexão

Esta seção contém informações sobre métodos e propriedades do objeto Ponto de Conexão (DrawConnectorPoint).
Este objeto não possui eventos associados.
Métodos
Esta seção contém informações sobre os métodos do objeto Ponto de Conexão (DrawConnectorPoint).
ConnectTo
ConnectTo(Object, SlotNameIndex)
Conecta este Ponto de Conexão a um outro objeto de Tela, indicado no parâmetro Object, e desfaz a conexão
existente, se necessário. O parâmetro SlotNameIndex indica o índice ou o nome onde este Ponto de Conexão deve se
conectar na Coleção de Pontos de Conexão.
Delete
Delete()
Remove este Ponto de Conexão. Após utilizar este método, qualquer tentativa de acessar este objeto retorna um erro.
Disconnect
Disconnect([X], [Y])
Desconecta este Ponto de Conexão e retorna Verdadeiro se estava conectado ou Falso se não estava conectado. Os
parâmetros X e Y são opcionais e indicam as coordenadas horizontais e verticais deste Ponto de Conexão.
Propriedades
Esta seção contém informações sobre as propriedades do objeto Ponto de Conexão (DrawConnectorPoint).
IsConnected
Indica se este Ponto de Conexão está conectado ou não a algum objeto de Tela. Caso esteja conectado, as
propriedades X e Y podem ser lidas mas não modificadas.
Name
Retorna o nome deste Ponto de Conexão. Esta propriedade é somente de leitura.

Visualização 109
NOTA
· O nome de um Ponto de Conexão pode mudar ao inserir ou remover Pontos de Conexão da Coleção de Pontos
de Conexão.
· O primeiro e o último Ponto de Conexão na Coleção de Pontos de Conexão são nomeados, respectivamente,
como "Begin" e "End". Todos os outros Pontos são nomeados como "PlugN", onde N é o índice do Ponto na
Coleção.

X
Indica a coordenada horizontal deste Ponto de Conexão em relação à borda esquerda da Tela, em unidades
Himetric.
Y
Indica a coordenada vertical deste Ponto de Conexão em relação à borda superior da Tela, em unidades Himetric.

[Link] E2Controls
Esta seção contém informações sobre eventos, métodos e propriedades de objetos E2Controls.

[Link].1 Propriedades Comuns

Esta seção contém informações sobre propriedades comuns aos objetos E2Controls.

[Link].1.1 Frame_BorderColor
Define uma cor para a moldura de um objeto.

[Link].1.2 Frame_BorderEnabled
Habilita ou desabilita a moldura de um objeto.

[Link].1.3 Frame_BorderThickness
Define a espessura da moldura de um objeto, em pixels.

[Link].1.4 Frame_Color
Define a cor de fundo da área de título de um objeto. O valor padrão desta propriedade é cinza (RGB(192, 192,
192)).

[Link].1.5 Frame_Enable
Habilita ou desabilita a exibição da moldura de um objeto. O valor padrão desta propriedade é, exceto para o
objeto E2Button.

[Link].1.6 Frame_Enable3D
Habilita ou desabilita o efeito 3D para a moldura de um objeto.

[Link].1.7 Frame_Separator
Habilita ou desabilita a exibição de uma linha separadora entre o título e o objeto.

[Link].1.8 Frame_Set3DInset
Se esta propriedade está ajustada para Verdadeiro, a borda de um objeto aparece rebaixada. Se está ajustada
para Falso, o valor padrão, a borda do objeto aparece ressaltada.

[Link].1.9 Frame_Thickness3D
Define a espessura da borda 3D da moldura de um objeto, em pixels.

[Link].1.10 Frame_Title
Esta propriedade define o título da moldura de um objeto.

110 Visualização
[Link].1.11 Frame_TitleColor
Define a cor da fonte do título da moldura de um objeto. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).

[Link].1.12 Frame_TitleEnabled
Habilita ou desabilita a exibição do título da moldura de um objeto. O valor padrão desta propriedade é
Verdadeiro.

[Link].1.13 Frame_TitleFont
Esta propriedade é utilizada para determinar a fonte do título da moldura de um objeto. Esta propriedade não
pode ser utilizada em scripts ou em Associações e é configurada unicamente via Elipse E3 Studio. Consulte o tópico
Fonte para mais informações sobre as subpropriedades desta propriedade.

[Link].2 E2Animation
Esta seção contém informações sobre propriedades do objeto E2Animation. Este objeto não possui eventos nem
métodos associados.

[Link].2.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto E2Animation.
BackgroundColor
Esta propriedade define a cor de fundo do objeto E2Animation. O valor padrão desta propriedade é branco
(RGB(255, 255, 255)).
BlinkTime
Define o intervalo de tempo, em milissegundos, do efeito de piscar do objeto.
Border
Habilita ou desabilita a exibição de uma borda ao redor do objeto.
DefaultZone
Define a zona padrão que é mostrada quando o Tag associado estiver fora dos limites das outras zonas definidas
para o objeto.
IsTransparent
Se o valor desta propriedade é Verdadeiro, define que o fundo do objeto é transparente, permitindo que o fundo
da Tela apareça. Caso contrário, a cor de fundo é sólida, definida em BackgroundColor.
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 de um objeto E2Animation. Esta propriedade é somente de leitura.

[Link].2.2 Coleção de Zonas

Esta seção contém informações sobre métodos do objeto Coleção de Zonas (AnimationZoneCollection). Este objeto
não contém eventos nem propriedades associadas.
Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Zonas (AnimationZoneCollection).
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.

Visualização 111
Zonas
As Zonas definem um conjunto de imagens de bitmap que são usadas para criar o efeito de animação no objeto. As
Zonas (AnimationZone) podem ser configuradas acessando a janela Propriedades do objeto, na aba E2Animation. As
opções desta janela estão descritas na tabela a seguir.
Opções disponíveis na aba E2Animation
OPÇÃO DESCRIÇÃO
Zonas Listagem com todas as Zonas definidas no objeto

Adicionar Adiciona uma nova Zona

Remover Apaga a Zona selecionada

Zona Padrão Define a Zona selecionada como a Zona padrão do

objeto

Pisca Define se o bitmap pisca quando o valor do objeto

estiver dentro do intervalo da Zona

Dica Mostra um texto de ajuda sobre a Zona

Mínimo Valor mínimo para a variação da Zona

Máximo Valor máximo para a variação da Zona

Arquivo de imagem Nome do arquivo de bitmap que é mostrado quando o

valor do objeto estiver dentro do intervalo da Zona

Exemplo Mostra uma prévia do arquivo de bitmap da Zona

selecionada

Propriedades
Esta seção contém informações sobre as propriedades das Zonas do objeto E2Animation (AnimationZone).
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.

[Link].3 E2Bitmap
Esta seção contém informações sobre propriedades do objeto E2Bitmap. Este objeto não possui eventos nem
métodos associados.

[Link].3.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto E2Bitmap.
Filename
Define o nome do arquivo de imagem associado ao objeto E2Bitmap. O caminho do arquivo pode ser tanto o
caminho completo do arquivo no disco, quanto o caminho relativo à aplicação, quando o arquivo de imagem é
inserido como um Recurso da aplicação. O valor padrão desta propriedade é vazio.
IsTransparent
Esta propriedade habilita ou desabilita a transparência do objeto, baseada na cor definida na propriedade
TransparentColor.

112 Visualização
TransparentColor
Define qual cor é considerada pela propriedade IsTransparent como sendo transparente. O valor padrão desta
propriedade é branco (RBG(255, 255, 255)).

[Link].4 E2Button
Esta seção contém informações sobre eventos e propriedades do objeto E2Button. Este objeto não possui métodos
associados.

[Link].4.1 Eventos
Esta seção contém informações sobre os eventos do objeto E2Button.
OnRelease
OnRelease()
Este evento é gerado quando o botão do mouse é solto.

[Link].4.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto E2Button.
Action
Esta propriedade define o comportamento do objeto E2Button quando é clicado. Os valores possíveis para esta
propriedade são 0 - MOMENTARY: Comportamento normal do botão, aparecendo rebaixado somente enquanto o
mouse está pressionado (padrão), 1 - TOGGLE: Possui dois estados, ligado e desligado ou 2 - JOG: Alterna entre dois
valores, um quando o botão é pressionado e outro quando o botão é solto.
Alignment
Determina o alinhamento do texto do botão. Os valores possíveis para esta propriedade são 0 -
HorizontalAlignmentLeft: Alinha o texto à esquerda, 1 - HorizontalAlignmentCenter: Alinha o texto ao centro
(padrão) ou 2 - HorizontalAlignmentRight: Alinha o texto à direita.
BackgroundColor0
Define a cor de fundo do botão, quando não está pressionado. O valor padrão desta propriedade é cinza
(RGB(192, 192, 192)).
BackgroundColor1
Define a cor de fundo do botão, quando está pressionado. O valor padrão desta propriedade é cinza (RGB(192,
192, 192)).
Bitmap0
Define a imagem do botão, quando não está pressionado. O valor padrão desta propriedade é vazio.
Bitmap1
Define a imagem do botão, quando está pressionado. O valor padrão desta propriedade é vazio.
Text0
Define o texto do botão, quando não está pressionado. O valor padrão desta propriedade é "DESLIGADO".
Text1
Define o texto do botão, quando está pressionado. O valor padrão desta propriedade é "LIGADO".
TextColor0
Define a cor do texto do botão, quando não está pressionado. O valor padrão desta propriedade é preto (RGB(0,
0, 0)).
TextColor1
Define a cor do texto do botão, quando está pressionado. O valor padrão desta propriedade é preto (RGB(0, 0,
0)).
TextFont0
Esta propriedade é utilizada para determinar a fonte deste botão quando não está pressionado. Esta propriedade
não pode ser utilizada em scripts ou em Associações, sendo configurada unicamente via Elipse E3 Studio. Consulte o
tópico Fonte para mais informações sobre as subpropriedades desta propriedade.

Visualização 113
TextFont1
Esta propriedade é utilizada para determinar a fonte deste botão quando está pressionado. Esta propriedade não
pode ser utilizada em scripts ou em Associações, sendo configurada unicamente via Elipse E3 Studio. Consulte o
tópico Fonte para mais informações sobre as subpropriedades desta propriedade.
Type
Define o tipo do botão. Os valores possíveis para esta propriedade são 0 - ButtonTypeKey: Comportamento
normal de um botão (padrão), 1 - ButtonTypeSwitchH: O comportamento do botão é o de uma chave dividida
horizontalmente, 2 - ButtonTypeSwitchV: O comportamento do botão é o de uma chave dividida verticalmente, 3 -
ButtonTypeLeverH: O comportamento do botão é o de uma alavanca que se movimenta da esquerda para a direita e
vice-versa, 4 - ButtonTypeLeverV: O comportamento do botão é o de uma alavanca que se movimenta de cima para
baixo e vice-versa, 5 - ButtonTypeTransparent: O botão é transparente, 6 - ButtonTypeUserBitmap: O botão alterna
a exibição das imagens definidas nas propriedades Bitmap0 e Bitmap1, 7 - ButtonTypeCheckbox: O comportamento
do botão é o mesmo de uma Caixa de Seleção ou 8 - ButtonTypeRadio: O comportamento do botão é o mesmo de
um Botão de Opções.
Value
Esta propriedade é um Variant que assume o valor contido na propriedade Value0 se o botão não está
pressionado, e o valor contido na propriedade Value1 se o botão está pressionado.
Value0
Define o valor da propriedade Value, quando o botão não está pressionado.
Value1
Define o valor da propriedade Value, quando o botão está pressionado.

[Link].5 E2Display
Esta seção contém informações sobre propriedades do objeto E2Display. Este objeto não possui eventos nem
métodos associados.

[Link].5.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto E2Display.
BackgroundColor
Esta propriedade define a cor de fundo do objeto. O valor padrão desta propriedade é cinza (RGB(192, 192, 192)).
BackgroundStyle
Define o estilo de fundo do objeto. Os valores possíveis para esta propriedade são 0 - bsTransparent: O fundo é
transparente ou 1 - bsOpaque: A cor definida em BackgroundColor é vísivel (padrão).
Format
Contém um texto que representa uma máscara, dentro da qual os valores do objeto 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, 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

114 Visualização
HorizontalAlignment
Define o alinhamento horizontal do texto do E2Display. Os valores possíveis para esta propriedade são 0 -
HorizontalAlignmentLeft: Alinha horizontalmente à esquerda, 1 - HorizontalAlignmentCenter: Alinha
horizontalmente ao centro (padrão) ou 2 - HorizontalAlignmentRight: Alinha horizontalmente à direita.
MultiLine
Define se o objeto possui múltiplas linhas ou não. Esta propriedade só tem efeito se a propriedade Value é do tipo
String.
TextColor
Define a cor do texto do objeto. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).
TextFont
Esta propriedade é utilizada para determinar a fonte deste objeto. Esta propriedade não pode ser utilizada em
Associações. Consulte o tópico Fonte para mais informações sobre as subpropriedades desta propriedade.
Value
Esta propriedade contém um Variant que pode assumir valores de todo e qualquer tipo de dados, e a forma de
apresentação destes valores é definida pela propriedade Format.
VerticalAlignment
Define o alinhamento vertical do texto do E2Display. Os valores possíveis para esta propriedade são 0 -
VerticalAlignmentTop: Alinha verticalmente com a parte superior do objeto, 1 - VerticalAlignmentMiddle: Alinha
verticalmente com o centro do objeto (padrão) ou 2 - VerticalAlignmentBottom: Alinha verticalmente com a parte
inferior do objeto.

[Link].6 E2Gauge
Esta seção contém informações sobre propriedades do objeto E2Gauge. Este objeto não possui eventos nem
métodos associados.

[Link].6.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto E2Gauge.
BackgroundColor
Esta propriedade define a cor de fundo do objeto. O valor padrão desta propriedade é cinza (RGB(128, 128, 128)).
BulletsVisible
Exibe ou esconde as marcas da escala em forma de bullet.
DecimalPlaces
Esta propriedade define o número de casas decimais para o valor nominal do E2Gauge.
FrameColor
Define a cor de fundo do objeto.
HiColorLegend
Define a cor da legenda para o limite Alto. O valor padrão desta propriedade é amarelo (RGB(255, 255, 0)).
HiDiv
Marca o início da escala para o limite Alto. O valor padrão desta propriedade é 13300.
HiHiColorLegend
Define a cor da legenda para o limite Muito Alto. O valor padrão desta propriedade é vermelho (RGB(255, 0, 0)).
HiHiDiv
Marca o início da escala para o limite Muito Alto. O valor padrão desta propriedade é 16600.
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.

Visualização 115
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.
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 para esta propriedade são 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
(padrão) ou 3 - Right: A parte inferior do objeto está alinhada com o lado direito da moldura.
Reverted
Habilita ou desabilita a reversão da escala do objeto.
ShowFrame
Habilita ou desabilita a exibição do fundo ao longo do percurso do ponteiro.
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)).

116 Visualização
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
Esta propriedade é utilizada para determinar a fonte do texto da escala. Esta propriedade não pode ser utilizada
em Associações. Consulte o tópico Fonte para mais informações sobre as subpropriedades desta propriedade.
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 padrão desta propriedade é Falso.

[Link].7 E2Setpoint
Esta seção contém informações sobre propriedades do objeto E2Setpoint. Este objeto não possui eventos nem
métodos associados.

[Link].7.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto E2Setpoint.
AutoSend
Se esta propriedade está em Verdadeiro (valor padrão), o valor definido na propriedade Value é atualizado nas
Associações assim que o objeto perder o foco. Caso contrário, as Associações só recebem o valor quando é usada a
tecla ENTER.
BackgroundColor
Esta propriedade define a cor de fundo do objeto. O valor padrão desta propriedade é cinza (RGB(192, 192, 192)).
BackgroundStyle
Define o estilo de fundo do objeto. Os valores possíveis para esta propriedade são 0 - bsTransparent: O fundo é
transparente ou 1 - bsOpaque: A cor definida em BackgroundColor é vísivel (padrão).
EnableMaxLimit
Habilita ou desabilita a definição de um limite máximo para o valor do E2Setpoint.
EnableMinLimit
Habilita ou desabilita a definição de um limite mínimo para o valor do E2Setpoint.
Format
Contém um texto que representa uma máscara, dentro da qual os valores do objeto 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, 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

Visualização 117
 · 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 possíveis para esta propriedade são 0 -
HorizontalAlignmentLeft: Alinha horizontalmente à esquerda, 1 - HorizontalAlignmentCenter: Alinha
horizontalmente ao centro (padrão) ou 2 - HorizontalAlignmentRight: Alinha horizontalmente à direita.
HScroll
Habilita ou desabilita a exibição de uma barra de rolagem horizontal no texto, caso a propriedade Multiline esteja
em Verdadeiro.
MaxLimit
Limite máximo que pode ser atingido pela propriedade Value do objeto. O valor padrão desta propriedade é 200.
O limite só é verificado se a propriedade EnableMaxLimit está habilitada.
MinLimit
Limite mínimo que pode ser atingido pela propriedade Value do objeto. O valor padrão desta propriedade é 0
(zero). O limite só é verificado se a propriedade EnableMinLimit está habilitada.
MultiLine
Define se o objeto possui múltiplas linhas ou não. Esta propriedade só está disponível se a propriedade Value é 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
Esta propriedade é utilizada para determinar a fonte deste objeto. Esta propriedade não pode ser utilizada
Associações. Consulte o tópico Fonte para mais informações sobre as subpropriedades desta propriedade.
Type
Define o tipo de Setpoint. Os valores possíveis para esta propriedade são 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, padrão) ou 2 - setpointDateTime: Aceita somente valores de
data e hora, que são convertidos para o formato definido nas configurações regionais.
Value
Esta propriedade define um valor para o E2Setpoint. A forma como este valor é visualizado é definida na
propriedade Format.
VerticalAlignment
Define o alinhamento vertical do texto do E2Setpoint. Os valores possíveis para esta propriedade são 0 -
VerticalAlignmentTop: Alinha verticalmente com a parte superior do objeto, 1 - VerticalAlignmentMiddle: Alinha

118 Visualização
verticalmente com o centro do objeto (padrão) ou 2 - VerticalAlignmentBottom: Alinha verticalmente com a parte
inferior do objeto.
VScroll
Habilita ou desabilita a exibição de uma barra de rolagem vertical no texto, caso a propriedade Multiline esteja em
Verdadeiro.

[Link].8 E2Text
Esta seção contém informações sobre propriedades do objeto E2Text. Este objeto não possui eventos nem métodos
associados.

[Link].8.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto E2Text.
BlinkTime
Define o intervalo de tempo, em milissegundos, do efeito de piscar do objeto.
DefaultZone
Define a Zona padrão do objeto.
Value
Esta propriedade contém um Variant que pode assumir valores de todo e qualquer tipo de dados, tais como
Integer, Boolean ou String, entre outros.
Zones
Coleção de Zonas do objeto E2Text. Esta propriedade é somente de leitura.

[Link].8.2 Coleção de Zonas

Esta seção contém informações sobre métodos do objeto Coleção de Zonas do objeto E2Text (TextZoneCollection).
Este objeto não possui eventos nem propriedades associadas.
Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Zonas do E2Text (TextZoneCollection).
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
As Zonas definem um conjunto de Zonas de Texto (TextZone) 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 Listagem com todas as Zonas definidas no objeto

Adicionar Adiciona uma nova Zona

Remover Remove a Zona selecionada

Pisca a cada (ms) Define se o texto e o fundo da Zona piscam quando o

valor do objeto estiver dentro do intervalo da Zona

Mensagem Texto da mensagem exibida quando o valor do objeto

estiver dentro do intervalo da Zona

Alinhamento Define o alinhamento do texto

Fonte Define a fonte do texto

Visualização 119
 OPÇÃO DESCRIÇÃO
Cor de fundo Define a cor de fundo da Zona

Transparente Define se o fundo do objeto é transparente quando a

Zona estiver ativa

Zona padrão Define a Zona selecionada como a Zona padrão do

objeto

Pisca Define se a Zona pisca quando o valor do objeto estiver

dentro do intervalo da Zona

Mínimo Valor mínimo para a Zona

Máximo Valor máximo para a Zona

Dica Mostra um texto de ajuda para a Zona

Exemplo Mostra um exemplo do comportamento da Zona em

tempo de execução

A seção a seguir contém informações sobre as propriedades do objeto Zona de uma Coleção de Zonas de um objeto
E2Text (TextZone). Este objeto não possui eventos nem métodos associados.
Propriedades
Esta seção contém informações sobre as propriedades dos objetos Zona (TextZone) de um objeto E2Text.
BackgroundColor
Define a cor de fundo do texto da Zona. O valor padrão desta propriedade é branco (RGB(255, 255, 255)).
Blink
Indica que esta Zona participa do efeito de piscar. O valor padrão desta propriedade é Falso. Se está habilitada,
esta Zona alterna com a Zona padrão, conforme o tempo definido na propriedade BlinkTime do objeto E2Text.
HorizontalAlignment
Define o alinhamento do texto. Os valores possíveis para esta propriedade são 0 - HorizontalAlignmentLeft:
Alinha horizontalmente à esquerda, 1 - HorizontalAlignmentCenter: Alinha horizontalmente ao centro (padrão) ou 2 -
HorizontalAlignmentRight: Alinha horizontalmente à direita.
Maximum
Define o valor máximo para a Zona. O valor padrão desta propriedade é 20000.
Message
Define o texto associado à Zona. Esta mensagem é mostrada quando o Tag associado está dentro dos limites da
Zona.
Minimum
Define o valor mínimo para a Zona. O valor padrão desta propriedade é 0 (zero).
TextColor
Define a cor do texto da Zona. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).
TextFont
Define o estilo, a cor e o tamanho da fonte usada para mostrar o texto da mensagem. Esta propriedade não pode
ser utilizada em Associações. Consulte o tópico Fonte para mais informações sobre as subpropriedades desta
propriedade.
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 está ativa.

120 Visualização
[Link] Elipse KeyPad
Esta seção contém informações sobre métodos e propriedades do objeto Elipse KeyPad. Este objeto não possui
eventos associados.

[Link].1 Métodos
Esta seção contém informações sobre os métodos do objeto Elipse KeyPad.

[Link].1.1 Hide
Hide()
Oculta o Elipse KeyPad. Este método não tem efeito se o KeyPad já está invisível.

[Link].1.2 Show
Show()
Mostra o Elipse KeyPad. Este método não tem efeito se o KeyPad já está visível na tela.

[Link].2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Elipse KeyPad.

[Link].2.1 AutoHideOnEnter
Automaticamente oculta o KeyPad quando a tecla ENTER do teclado virtual é pressionada.

[Link].2.2 AutoHideOnEsc
Automaticamente oculta o KeyPad quando a tecla ESC do teclado virtual é pressionada.

[Link].2.3 Layout
Permite alterar o layout de apresentação do KeyPad. Os valores possíveis para esta propriedade são os seguintes:
· br-simple: Mostra um teclado alfanumérico

Exemplo de KeyPad alfanumérico

· num: Mostra um teclado numérico

Visualização 121
 Exemplo de KeyPad numérico
O script a seguir contém um exemplo de uso desta propriedade.
' Alterna entre os modos Alfanumérico e Numérico
Sub ToggleButton1_Click()
If [Link] Then
[Link]().Layout = "br-simple"
Else
[Link]().Layout = "num"
End If
End Sub

[Link].2.4 SizeFactor
Aumenta ou diminui o tamanho original do KeyPad, utilizando um fator de multiplicação. O tamanho original do
KeyPad é mostrado na tabela a seguir.
Valores padrão de tamanho do KeyPad
LAYOUT LARGURA ALTURA
Alfanumérico 550 px 250 px

Numérico 200 px 300 px

O exemplo a seguir redimensiona o KeyPad para 75% do tamanho original.

Sub Botao1_Click()
[Link]().SizeFactor = 0.75
[Link]().Show()
End Sub

[Link].2.5 Sound
Permite alterar o som emitido ao clicar-se em uma tecla do KeyPad. O valor padrão desta propriedade é uma
String vazia, significando que nenhum som é emitido ao clicar-se em uma tecla. Caso seja alterado o valor desta
propriedade, é necessário que o novo valor seja o caminho absoluto de um arquivo no formato WAV ou então que
este arquivo esteja incluído no Domínio como um Recurso.

[Link].2.6 X
A coordenada X do canto superior esquerdo do objeto KeyPad. Esta propriedade pode ser usada para mover o
KeyPad no sentido horizontal.

[Link].2.7 Y
A coordenada Y do canto superior esquerdo do objeto KeyPad. Esta propriedade pode ser usada para mover o
KeyPad no sentido vertical.

122 Visualização
[Link] Escala
Esta seção contém informações sobre propriedades do objeto Escala (DrawScale). Este objeto não possui eventos
nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Escala (DrawScale).

[Link].1.1 BackgroundColor
Esta propriedade especifica a cor de preenchimento do fundo do objeto. Esta cor é utilizada quando a propriedade
BackgroundStyle está configurada para 1 (um, opaco) e umas das propriedades VerticalPercentFill ou
HorizontalPercentFill está com valores diferentes de 100. Outro uso desta cor é quando a propriedade FillStyle está
configurada entre os valores 2 (dois) e 8 (oito). Isto permite que a área restante utilize a cor de fundo para
preenchimento. 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)).

[Link].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 edição. O valor padrão desta propriedade é branco (RGB(255, 255,
255)). O script a seguir contém um exemplo de uso desta propriedade.
Sub Escala1_Click()
BorderColor = RGB (255, 0, 0)
End Sub

[Link].1.3 BorderStyle
Esta propriedade determina o estilo de borda que é aplicada ao objeto Escala. Os valores possíveis para esta
propriedade estão descritos na tabela a seguir.
Opções disponíveis para a propriedade BorderStyle
OPÇÃO DESCRIÇÃO
0 - Normal Aplica uma borda sólida na grade vertical da escala

1 - Dash Aplica uma borda de linha tracejada na escala

2 - Dot Aplica uma borda pontilhada na escala

3 - DashDot Aplica uma borda de traço e ponto na escala

4 - DashDotDot Aplica uma borda de traço, ponto e ponto na escala

5 - Null O objeto não tem borda (padrão)

[Link].1.4 BorderWidth
Esta propriedade determina a largura, em pixels, da borda do objeto Escala. Através desta propriedade, é possível
configurar a largura da borda sem precisar modificar a estrutura. O valor padrão desta propriedade é 0 (zero).

[Link].1.5 ForegroundColor
Esta propriedade especifica a cor do preenchimento da frente do objeto. Esta cor é utilizada quando a propriedade
FillStyle está configurada para 0 (zero, sólido) ou entre 2 (dois) e 9 (nove). 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 é azul (RGB(0, 0,
255)). O script a seguir contém um exemplo de uso desta propriedade.
Sub Botao1_Click()
' Troca a cor de fundo do botao para verde
'quando se clica no objeto
ForegroundColor = RGB(0, 255, 0)
End Sub

[Link].1.6 Format
Esta propriedade especifica que tipo de formato é atribuído ao objeto. Permite mudar a forma como os dados são
apresentados sem mudar o valor existente por trás destes dados. Esta propriedade pode ser editada manualmente

Visualização 123
ou configurada através da janela de formatação. O uso é semelhante aos formatadores usados nas planilhas de
dados, seguindo a mesma sintaxe. A tabela a seguir contém os tipos de dados suportados.
Tipos de dados suportados pela propriedade Format
TIPO DE DADOS DESCRIÇÃO
Numérico Saída decimal, científica, hexadecimal, binária ou octal

Texto Textos em geral

Booleano Valores Booleanos

Data/Hora Calendário Gregoriano

[Link].1.7 LineColor
Determina a cor da linha com as marcas divisórias e subdivisórias da Escala. Para determinar a cor da legenda com
números do objeto, use a propriedade TextColor. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).

[Link].1.8 MaximumValue
Esta propriedade determina o valor máximo atingido pela Escala. O valor padrão desta propriedade é 100. O script
a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton_Click()
' Ao clicar no botão, abre um MessageBox indicando
' o valor máximo da propriedade da escala
MsgBox CSTr([Link]("Escala1").MaximumValue)
End Sub

[Link].1.9 MinimumValue
Esta propriedade determina o valor mínimo requerido pela Escala. O valor padrão desta propriedade é 0 (zero). O
script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
' Ao clicar no botão, abre um MessageBox indicando
' o valor da propriedade Minimum do Escala1
MsgBox _
CSTr([Link]("Dados.Escala1").MinimumValue)
End Sub

[Link].1.10 MinorTicks
Esta propriedade determina a quantidade de marcas da Escala. O valor padrão desta propriedade é 3 (três). O
script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
' Mostra o total de marcas da escala
MsgBox CStr([Link]("Escala1").MinorTicks)
End Sub

[Link].1.11 MinorTicksPercentSize
Esta propriedade determina o tamanho das marcas que subdividem cada medida do objeto Escala. O valor padrão
desta propriedade é 10.

[Link].1.12 ScaleAlignment
Esta propriedade determina o tipo de alinhamento que é atribuído à Escala. Os valores possíveis para esta
propriedade são 0 - RightSide: À direita (padrão) ou 1 - LeftSide: À esquerda.

[Link].1.13 ShowText
Esta propriedade determina a visibilidade do texto na legenda do objeto Escala. Se esta propriedade está
habilitada, o texto é mostrado. Caso contrário, o objeto mostra somente as linhas e subdivisões da Escala. O valor
padrão desta propriedade é Verdadeiro.

[Link].1.14 StretchText
Esta propriedade determina a aplicação de extensão (stretch) ao texto do objeto Escala. Caso a largura ou altura da
Escala sejam alteradas, o texto acompanha esta variação. Se esta propriedade está habilitada, o objeto acompanha as

124 Visualização
variações de altura e largura do objeto conforme seja transformado. Caso contrário, o texto permanece com as
configurações iniciais. O valor padrão desta propriedade é Falso.

[Link].1.15 TextAlignment
Esta propriedade determina o alinhamento do texto no objeto. Os valores possíveis para esta propriedade estão
descritos na tabela a seguir.
Opções disponíveis para a propriedade TextAlignment
OPÇÃO DESCRIÇÃO
0 - LeftAlignment O alinhamento do texto é à esquerda (padrão)

1 - CenterAlignment O alinhamento do texto é centralizado

2 - RightAlignment O alinhamento do texto é à direita

[Link].1.16 TextColor
Determina a cor da fonte aplicada na legenda com números do objeto Escala. Para determinar a cor da linha com
as marcas divisórias e subdivisórias da Escala, utilize a propriedade LineColor. O valor padrão desta propriedade é
preto (RGB(0, 0, 0)).

[Link].1.17 TextFont
Esta propriedade determina a fonte que é aplicada na Escala. A fonte selecionada é aplicada em todo o objeto
Escala. Esta propriedade não pode ser utilizada em Associações e as sub-propriedades podem ser consultadas no
tópico Fonte.

[Link].1.18 Ticks
Determina a quantidade de divisórias que a Escala tem. O valor padrão desta propriedade é 5 (cinco).

[Link].1.19 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.

[Link] Figura
Esta seção contém informações sobre métodos e propriedades do objeto Figura (DrawPicture). Este objeto não
possui eventos associados.

[Link].1 Métodos
Esta seção contém informações sobre os métodos do objeto Figura (DrawPicture).

[Link].1.1 ScaleImage
ScaleImage(PercX, PercY, AnchorType)
Este método permite ajustar o tamanho de uma Figura proporcionalmente ao tamanho original. Os parâmetros PercX
e PercY definem, respectivamente, os tamanhos percentuais horizontal e vertical da Figura em relação ao tamanho
original. O parâmetro AnchorType define um ponto de ancoragem para este ajuste. Os valores possíveis para este
parâmetro são 0: Center (mantém fixo o centro da Figura), 3: TopLeft (mantém fixo o canto esquerdo superior da
Figura), 4: BottomLeft (mantém fixo o canto esquerdo inferior da Figura), 5: BottomRight (mantém fixo o canto direito
inferior da Figura) ou 6: TopRight (mantém fixo o canto direito superior da Figura).

[Link].2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Figura (DrawPicture).

[Link].2.1 BackgroundColor
Esta propriedade especifica a cor de preenchimento do fundo do objeto. Esta cor é utilizada quando a propriedade
BackgroundStyle está configurada para 1 (um, opaco) e umas das propriedades VerticalPercentFill ou
HorizontalPercentFill está com valores diferentes de 100. 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)).

Visualização 125
[Link].2.2 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, permitindo que a área
restante utilize a cor configurada na propriedade BackgroundColor para preenchimento. A tabela a seguir contém os
valores válidos para esta propriedade.
Opções disponíveis para a propriedade BackgroundStyle
OPÇÃO DESCRIÇÃO
0 - Transparent Nenhum fundo deste objeto é desenhado

1 - Opaque Caso visível, o fundo é desenhado (padrão)

[Link].2.3 Convert
Esta propriedade permite a conversão da figura. Se esta propriedade está configurada em 0 (zero), é possível
visualizar a conversão. Caso contrário, não é possível visualizar a conversão. Esta propriedade só aceita os valores 0
(zero) e 1 (um). O valor padrão desta propriedade é 0 (zero).

[Link].2.4 EnableOverrideLineColor
Esta propriedade habilita ou desabilita o objeto a sobrescrever a cor original da linha da imagem pela cor definida
na propriedade OverrideLineColor. Se esta propriedade está habilitada, permite que seja modificada a cor original
da linha do objeto pela cor de OverrideLineColor. Caso contrário, o objeto Figura exibe a cor original.

[Link].2.5 Filename
Define o nome do arquivo de imagem associado a este objeto. O caminho do arquivo pode ser tanto o caminho
completo do arquivo no disco quanto o caminho relativo à aplicação, quando inserido o arquivo de imagem como um
Recurso da aplicação. O valor padrão desta propriedade é vazio. A tabela a seguir contém os tipos de arquivos de
imagem suportados.
Tipos de arquivos de imagem suportados
ARQUIVO FILTRO DESCRIÇÃO FILTRO
Bitmap BMP Não Sim

Graphics Interchange GIF Não Sim

Format
Joint Photographic JPG Não Sim
Experts Group
ICO File Format ICO Não Sim

Windows Metafile WMF Não Sim

Enhanced Metafile EMF Não Sim

Portable Network PNG Não Sim

Graphics
Tagged Image File Format TIF Não Sim

[Link].2.6 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 a propriedade HorizontalFillStyle
OPÇÃO DESCRIÇÃO
0 - FillLeftToRight A porcentagem de preenchimento é da esquerda para a
direita (padrão)

126 Visualização
 OPÇÃO DESCRIÇÃO
1 - FillRightToLeft A porcentagem de preenchimento é da direita para a
esquerda

2 - FillCenterToEdgesH A porcentagem de preenchimento é do centro para as

bordas

[Link].2.7 HorizontalPercentFill
Utilize esta propriedade para especificar qual a porcentagem da área horizontal do objeto deve ser preenchida. Os
valores aceitos por esta 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. O script a seguir contém um exemplo de uso desta propriedade.
Sub Circulo1_OnStartRunning()
HorizontalPercentFill = 200
End Sub

[Link].2.8 IgnoreFlipHorizontal
Esta propriedade força com que a imagem carregada neste objeto mantenha a orientação original em relação ao
eixo horizontal, independente da configuração da propriedade FlipHorizontal, comum a todos os objetos de Tela. O
valor padrão desta propriedade é Falso.

NOTAS
· Esta propriedade só tem efeito se o objeto Figura não foi convertido para símbolo, ou seja, a propriedade
Convert está configurada para o valor 0 (zero).
· Para objetos criados em versões anteriores à implementação desta propriedade e abertos em aplicações a partir
da versão 6.7, o valor desta propriedade é configurado para Verdadeiro.

[Link].2.9 IgnoreFlipVertical
Esta propriedade força com que a imagem carregada neste objeto mantenha a orientação original em relação ao
eixo vertical, independente da configuração da propriedade FlipVertical, comum a todos os objetos de Tela. O valor
padrão desta propriedade é Falso.

NOTAS
· Esta propriedade só tem efeito se o objeto Figura não foi convertido para símbolo, ou seja, se a propriedade
Convert está configurada para o valor 0 (zero).
· Para objetos criados em versões anteriores à implementação desta propriedade e abertos em aplicações a partir
da versão 6.7, o valor desta propriedade é configurado para Verdadeiro.

[Link].2.10 OverrideFillColor
Quando a propriedade OverrideFillMode é configurada com os valores 2 (dois) ou 3 (três), esta propriedade é
usada para definir a cor a ser usada no preenchimento da imagem, 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)). O script a seguir contém um exemplo de uso desta propriedade.
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
Esta propriedade só tem efeito quando o objeto Figura trabalha com arquivos Metafile (WMF ou EMF).

Visualização 127
[Link].2.11 OverrideFillMode
Esta propriedade especifica o modo do preenchimento da imagem do objeto, quando este está mostrando um
arquivo Windows Metafile e altera o modo original de preenchimento da imagem sem alterar o arquivo definido pela
propriedade Filename. A tabela a seguir contém os valores válidos para esta propriedade.
Opções disponíveis para a propriedade OverrideFillMode
OPÇÃO DESCRIÇÃO
0 - NoOverride A imagem mantém o preenchimento original (padrão)

1 - Wireframe A imagem não é preenchida

2 - SolidFill A imagem é preenchida com a cor especificada pela

propriedade OverrideFillColor

3 - ByBrightness A imagem é preenchida com a cor especificada pela

propriedade OverrideFillColor, porém leva em conta
qual era a intensidade da cor original da imagem

O script a seguir contém um exemplo de uso desta propriedade.

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
Esta propriedade só tem efeito quando o objeto Figura trabalha com arquivos Metafile (WMF ou EMF).

[Link].2.12 OverrideLineColor
Quando a propriedade EnableOverrideLineColor está configurada para Verdadeiro, esta propriedade é usada
para definir a cor a ser usada na cor da linha da figura, 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)). O script a seguir contém um exemplo de uso desta propriedade.
Sub DrawPicture1_Click()
OverrideLineColor = RGB(0, 0, 255)
End Sub

NOTA
Esta propriedade só tem efeito quando o objeto Figura trabalha com arquivos Metafile (WMF ou EMF).

[Link].2.13 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.

[Link].2.14 ShadowColor
Especifica a cor do preenchimento da sombra do objeto. Esta cor é utilizada quando a propriedade Shadow está
configurada para Verdadeiro. 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 escuro (RGB(128, 128, 128)). O script a seguir contém um
exemplo de uso desta propriedade.
Sub Botao1_Click()
' Troca a cor de fundo do botao para cinza claro
' quando se clica no objeto
ShadowColor = RGB(192, 192, 192)
End Sub

128 Visualização
NOTA
Esta propriedade só tem efeito quando o objeto Figura trabalha com arquivos Metafile (WMF ou EMF).

[Link].2.15 ShadowX
Define a coordenada vertical à esquerda da sombra deste objeto, em unidades Himetric. Esta sombra é sempre
relativa à propriedade X do objeto. Valores positivos indicam que a sombra está à direita do objeto, e negativos à
esquerda. O valor padrão desta propriedade é 200.

[Link].2.16 ShadowY
Define a coordenada horizontal superior da sombra deste objeto, em unidades Himetric. Esta sombra é sempre
relativa a propriedade Y do objeto. Valores positivos indicam que a sombra está abaixo do objeto, e negativos acima.
O valor padrão desta propriedade é 200. O script a seguir contém um exemplo de uso desta propriedade.
Sub Botao1_Click()
ShadowY = 250
End Sub

NOTA
Esta propriedade só tem efeito quando o objeto Figura trabalha com arquivos Metafile (WMF ou EMF).

[Link].2.17 TransparentColor
Quando a propriedade TransparentMode está configurada para 1 (um), esta propriedade define qual cor da
imagem não é desenhada, e a imagem permanece transparente nestes pontos. 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 é branco
(RGB(255, 255, 255)). O script a seguir contém um exemplo de uso desta propriedade.
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

[Link].2.18 TransparentMode
Esta propriedade especifica o modo como é o efeito de transparência na imagem. A tabela a seguir contém os
valores possíveis para esta propriedade.
Opções disponíveis para a propriedade TransparentMode
OPÇÃO DESCRIÇÃO
0 - Disabled Nenhuma transparência é efetuada (padrão)

1 - ByColor A transparência é de acordo com a cor definida na

propriedade TransparentColor

2 - ByPercent A imagem permanece translúcida com porcentagem de

transparência especificada na propriedade
TransparentPercent

O script a seguir contém um exemplo de uso desta propriedade.

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

[Link].2.19 TransparentPercent
Quando a propriedade TransparentMode está configurada para 2 (dois), esta propriedade define quão translúcida
a imagem é exibida, variando de 0 (zero, totalmente translúcida) a 100 (opaca ou sólida). O script a seguir contém um
exemplo de uso desta propriedade.
Sub DrawPicture1_Click()
' Deixa a imagem translúcida quando se clica no objeto

Visualização 129
 TransparentMode = 1 ' ByPercent
TransparentPercent = 50 ' 50% translúcido
End Sub

[Link].2.20 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 a propriedade VerticalFillStyle
OPÇÃO DESCRIÇÃO
0 - FillBottomToTop A porcentagem de preenchimento é de baixo para cima
(padrão)

1 - FillTopToBottom A porcentagem de preenchimento é de cima para baixo

2 - FillCenterToEdgesV A porcentagem de preenchimento é do centro para as

bordas

[Link].2.21 VerticalPercentFill
Utilize esta propriedade para especificar qual a porcentagem da área vertical do objeto deve ser preenchida. Os
valores aceitos por esta propriedade variam de 0 (zero) a 100. Esta propriedade trabalha em conjunto com a
propriedade VerticalFillStyle, que informa como este preenchimento ocorre. O valor padrão desta propriedade é
100.

[Link] Fonte
Esta seção contém informações sobre propriedades do objeto Fonte (Font) retornado pelas propriedades que
configuram uma fonte para os textos dos objetos de Tela, exceto os MS Forms. Este objeto não possui eventos nem
métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Fonte (Font) retornado pelas propriedades que
configuram uma fonte para os textos dos objetos de Tela, exceto os MS Forms.

[Link].1.1 Bold
Esta propriedade indica se o texto do objeto de Tela está em negrito.

[Link].1.2 Charset
Esta propriedade indica o conjunto de caracteres disponível para a fonte do objeto de Tela. Os valores possíveis
para esta propriedade estão descritos na tabela a seguir.
Valores disponíveis para a propriedade Charset
VALOR PÁGINA DE CÓDIGO NOME DESCRIÇÃO
0 1252 ANSI_CHARSET ANSI (American National
Standards Institute)

1 -- DEFAULT_CHARSET Padrão (mostra o conjunto

de caracteres disponível na
Fonte)

2 -- SYMBOL_CHARSET Símbolos

128 932 SHIFTJIS_CHARSET Japonês (Shift-JIS)

129 949 HANGUL_CHARSET Coreano

134 936 GB2312_CHARSET Chinês Simplificado (GBK)

136 950 CHINESEBIG5_CHARSET Chinês Tradicional (Big5)

161 1253 GREEK_CHARSET Grego

162 1254 TURKISH_CHARSET Turco

130 Visualização
 VALOR PÁGINA DE CÓDIGO NOME DESCRIÇÃO
177 1255 HEBREW_CHARSET Hebraico

178 1256 ARABIC_CHARSET Árabe

186 1257 BALTIC_CHARSET Báltico

204 1251 RUSSIAN_CHARSET Cirílico

222 874 THAI_CHARSET Tailandês

238 1250 EE_CHARSET Centro-Europeu

255 -- OEM_CHARSET OEM (Original Equipment

Manufacturer)

[Link].1.3 Italic
Esta propriedade indica se o texto do objeto de Tela está em itálico.

[Link].1.4 Name
Esta propriedade indica o nome da fonte do objeto de Tela.

[Link].1.5 Size
Esta propriedade indica o tamanho, em pontos, da fonte do texto do objeto de Tela.

[Link].1.6 Strikethrough
Esta propriedade indica se o texto do objeto de Tela usa o efeito de tachado.

[Link].1.7 Underline
Esta propriedade indica se o texto do objeto de Tela usa o efeito de sublinhado.

[Link].1.8 Weight
Esta propriedade indica a variação do efeito de negrito na fonte do objeto de Tela, ou seja, da propriedade Bold.
Os valores para esta propriedade podem variar entre 0 (zero, não interfere no efeito de negrito) e 1000.

[Link] Grupo
Esta seção contém informações sobre propriedades do Grupo de objetos (DrawGroup). Este objeto não possui
eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre propriedades do Grupo de objetos (DrawGroup).

[Link].1.1 EnableOverrideLineColor
Esta propriedade habilita ou desabilita o objeto Grupo a sobrescrever as cores originais das linhas dos objetos
contidos no Grupo. Se esta propriedade está habilitada, as cores originais das linhas dos objetos do Grupo são
substituídas pela cor definida na propriedade OverrideLineColor. Caso contrário, cada objeto contido no Grupo
apresenta a cor de linha original. O valor padrão desta propriedade é Falso.

[Link].1.2 OverrideFillColor
Quando a propriedade OverrideFillMode está configurada para 2 (dois) ou 3 (três), esta propriedade é usada para
definir a cor a ser usada no 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)).

[Link].1.3 OverrideFillMode
Esta propriedade especifica o modo do preenchimento dos objetos que estão dentro do Grupo e altera o modo
original de preenchimento da imagem, sem alterar a configuração original de preenchimento dos objetos.

Visualização 131
 Opções disponíveis para a propriedade OverrideFillMode
OPÇÃO DESCRIÇÃO
0 - NoOverride Preenchimento original do objeto (padrão)

1 - Wireframe Os objetos não são preenchidos, desenham somente as

bordas

2 - SolidFill O preenchimento dos objetos contidos no Grupo é

sólido com a cor especificada na propriedade
OverrideFillColor

3 - ByBrightness O preenchimento dos objetos contidos no Grupo é

sólido com a cor especificada pela propriedade
OverrideFillColor, porém leva em conta qual era a
intensidade da cor original de preenchimento de cada
objeto

[Link].1.4 OverrideLineColor
Quando a propriedade EnableOverrideLineColor está configurada para Verdadeiro, esta propriedade é usada
para definir a cor a ser usada na cor da linha dos objetos do 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)).

[Link] Microsoft Forms

Esta seção contém informações sobre eventos e propriedades comuns de objetos Microsoft Forms. Estes objetos
não possuem métodos comuns associados.

[Link].1 Eventos Comuns

Esta seção contém informações sobre os eventos comuns aos objetos Microsoft Forms.

[Link].1.1 BeforeDragOver
BeforeDragOver(Index, Cancel, Data, X, Y, DragState, Effect, Shift)
Ocorre quando há uma ação de arrastar e soltar (drag-and-drop) sobre um objeto. Utilize este evento para monitorar
se o ponteiro do mouse entrou, deixou ou permaneceu sobre um objeto alvo. O evento é disparado quando o
usuário move o ponteiro do mouse ou pressiona ou solta algum botão do mouse. A posição do ponteiro do mouse
indica qual objeto gerou o evento. Pode-se determinar o status do ponteiro do mouse examinando o parâmetro
DragState.
Muitos objetos não suportam operações de arrastar e soltar enquanto o parâmetro Cancel tem o valor Falso, que é o
padrão. Isto significa que o objeto rejeita qualquer tentativa de arrastar ou soltar algum outro objeto sobre si e,
consequentemente, não dispara o evento BeforeDropOrPaste. O objeto Text Box (Caixa de Texto) e o objeto Combo
(Lista de Seleção) são exceções. Estes objetos aceitam operações de arrastar e soltar mesmo quando o parâmetro
Cancel tem o valor Falso.
Parâmetros disponíveis no evento BeforeDragOver
NOME DESCRIÇÃO
Index Indica o índice da página, em um objeto multi-páginas,
que é afetada pela operação que gerou o evento. Para
outros objetos é ignorada

Cancel Status do evento. O padrão é Falso e indica que é o

objeto alvo que trata o evento e não a aplicação
principal

Data Dados sendo arrastados para o objeto alvo,

propriamente ditos

X, Y Posição do ponteiro do mouse dentro do objeto alvo,

em pontos. X é medido a partir do lado esquerdo do
objeto e Y é medido a partir do topo

132 Visualização
 NOME DESCRIÇÃO
DragState Indica a condição do ponteiro do mouse quando este
evento é gerado. Os valores possíveis para este
parâmetro são 0 - fmDragStateEnter: O ponteiro do
mouse está dentro do alcance do objeto, 1 -
fmDragStateLeave: O ponteiro do mouse está fora do
alcance do objeto ou 2 - fmDragStateOver: O ponteiro
do mouse está em uma nova posição, mas ainda está
dentro do alcance do objeto

Effect Indica as ações que o objeto alvo suporta, ou seja, o

efeito de arrastar sobre o objeto alvo. Os valores
possíveis para este parâmetro são 0 -
fmDropEffectNone: Objeto alvo não aceita copiar ou
mover de alguma origem, 1 - fmDropEffectCopy: Objeto
alvo permite copiar de alguma origem para si, 2 -
fmDropEffectMove: Objeto alvo permite mover de
alguma origem para si ou 3 -
fmDropEffectCopyOrMove: Objeto alvo permite copiar
ou mover de alguma origem para si

Shift Inteiro cuja soma dos fatores indica o status das teclas
SHIFT, CTRL e ALT. Os valores possíveis para este
parâmetro são 1: Tecla SHIFT pressionada, 2: Tecla CTRL
pressionada ou 4: Tecla ALT pressionada. Por exemplo,
um valor igual a 5 (cinco) indica que as teclas SHIFT e ALT
estavam pressionadas (1 + 4 = 5)

[Link].1.2 BeforeDropOrPaste
BeforeDropOrPaste(Index, Cancel, Ctrl, Action, Data, X, Y, Effect, Shift)
Disparado no momento imediatamente anterior a uma operação de arrastar e soltar. Normalmente, isto ocorre logo
após o evento BeforeDragOver.
Parâmetros disponíveis no evento BeforeDropOrPaste
NOME DESCRIÇÃO
Index Indica o índice da página, em um objeto multi-páginas,
que é afetada pela operação que gerou o evento. Para
outros objetos é ignorada

Cancel Status do evento. O padrão é Falso e indica que é o

objeto alvo que trata o evento e não a aplicação
principal

Ctrl Objeto alvo

Action Indica o resultado, baseado nas configurações do

teclado, de uma operação de arrastar e soltar pendente.
Os valores possíveis para este parâmetro são 2 -
fmActionPaste: Cola o objeto selecionado no objeto
alvo ou 3 - fmActionDragDrop: Indica que o usuário
arrastou o objeto selecionado de sua origem e soltou-o
sobre o objeto alvo

Data Dados sendo arrastados para o objeto alvo,

propriamente ditos

X, Y Posição do ponteiro do mouse dentro do objeto alvo,

em pontos. X é medido a partir do lado esquerdo do
objeto e Y é medido a partir do topo

Visualização 133
 NOME DESCRIÇÃO
Effect Indica as ações que o objeto alvo suporta, ou seja, o
efeito de arrastar sobre o objeto alvo. Os valores
possíveis para este parâmetro são 0 -
fmDropEffectNone: Objeto alvo não aceita copiar ou
mover de alguma origem, 1 - fmDropEffectCopy: Objeto
alvo permite copiar de alguma origem para si, 2 -
fmDropEffectMove: Objeto alvo permite mover de
alguma origem para si ou 3 -
fmDropEffectCopyOrMove: Objeto alvo permite copiar
ou mover de alguma origem para si

Shift Inteiro cuja soma dos fatores indica o status das teclas
SHIFT, CTRL e ALT. Os valores possíveis para este
parâmetro são 1: Tecla SHIFT pressionada, 2: Tecla CTRL
pressionada ou 4: Tecla ALT pressionada. Por exemplo,
um valor igual a 5 (cinco) indica que as teclas SHIFT e ALT
estavam pressionadas (1 + 4 = 5)

[Link].1.3 Change
Change()
Ocorre quando o valor da propriedade Value de um objeto é modificada. A seguir estão alguns exemplos de ações
que disparam este evento:
· 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 uma Barra de Rolagem
· Clicar nas setas de um Botão Incremento-Decremento
· Selecionar diferentes páginas em um objeto multi-páginas

[Link].1.4 Error
Error(Number, Description, SCode, Source, HelpFile, HelpContext, CancelDisplay)
Gerado por um erro interno em um objeto. Se este evento não é tratado, o Elipse E3 mostra uma mensagem de erro
genérica.
Parâmetros disponíveis no evento Error
NOME DESCRIÇÃO
Number Número inteiro identificador do erro

Description String com a descrição do erro

SCode Inteiro com o código de erro do subsistema OLE (não

utilizado)

Source String com o objeto que originou o erro

HelpFile String com o nome e o caminho do arquivo de ajuda

HelpContext Número inteiro de contexto do tópico de ajuda referente

ao erro

CancelDisplay Booleano que indica se o erro deve ser mostrado em

uma caixa de mensagem

[Link].1.5 KeyPress
KeyPress(KeyAscii)
Ocorre quando um 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 no parâmetro KeyAscii), ou seja, o evento ocorre
quando alguma das teclas a seguir são pressionadas:

134 Visualização
 · 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

Este evento não ocorre nas seguintes condições:

· Pressionando a tecla TAB
· Pressionando a tecla ENTER
· Pressionando a tecla DEL (esta tecla não é padrão ANSI)
· Pressionando as setas do teclado
· Quando uma tecla move o foco de um objeto para outro

Enquanto o usuário pressiona uma tecla que produz um código ANSI, o objeto recebe o evento KeyDown e este
evento 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 por este evento, tais como teclas de função e navegação, utilize os
eventos KeyDown e KeyUp.

NOTA
Para uma lista com todos os códigos de tecla disponíveis para o parâmetro KeyAscii, consulte o artigo Keys Enum no
Microsoft Learn.

[Link].2 Propriedades Comuns

Esta seção contém informações sobre as propriedades comuns aos objetos Microsoft Forms.

NOTA
O Elipse E3 utiliza para definição de coordenadas e espessura o sistema Himetric. Neste sistema, cada unidade
lógica equivale a um milésimo de centímetro, ou seja, cada 1000 unidades equivalem a um centímetro. Assim, este é
o padrão adotado na descrição das propriedades do Elipse E3, quando aplicável.

[Link].2.1 BackColor
Determina a cor de fundo de um 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)).

[Link].2.2 ForeColor
Especifica a cor do preenchimento do fundo de um 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 todos os objetos Microsoft
Forms é a cor preta (RGB(0, 0, 0)).

[Link].2.3 MouseIcon
Esta propriedade atribui uma imagem ao ponteiro do mouse quando este é movido sobre um objeto. Esta
propriedade é válida somente quando a propriedade MousePointer está definida como 99 -
fmMousePointerCustom.
Um arquivo com imagem pode ser selecionado para o ponteiro do mouse através da Lista de Propriedades
(extensões .cur ou .ico) ou via scripts, utilizando-se a função LoadPicture para especificar o caminho e o nome do
arquivo que contém o ícone personalizado (somente arquivos com a extensão .cur). O script a seguir contém um
exemplo de uso desta propriedade.
Sub CommandButton1_Click()
' Atribuindo o item 99 - fmMousePointerCustom à propriedade
' para que ela aceite a personalização do ícone do mouse
[Link]("CheckBox1").MousePointer = 99
[Link]("CheckBox1").MouseIcon = LoadPicture("c:\[Link]")
End Sub

Visualização 135
[Link].2.4 MousePointer
Esta propriedade especifica o tipo de ponteiro do mouse que é mostrado quando o usuário o posiciona sobre um
objeto. As opções disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade MousePointer
OPÇÃO DESCRIÇÃO
0 - fmMousePointerDefault Ponteiro padrão (a imagem é determinada pelo objeto)

1 - fmMousePointerArrow Seta

2 - fmMousePointerCross Ponteiro em forma de cruz

3 - fmMousePointerIBeam Em forma de I

6 - fmMousePointerSizeNESW Seta dupla apontando para nordeste e sudoeste

7 - fmMousePointerSizeNS Seta dupla apontando para norte e sul

8 - fmMousePointerNWSE Seta dupla apontando para noroeste e sudeste

9 - fmMousePointerWE Seta dupla apontando para oeste e leste

10 - fmMousePointerUpArrow Seta para cima

11 - fmMousePointerHourglass Ampulheta

12 - fmMousePointerNoDrop Símbolo de Not (círculo com uma linha diagonal) na

parte superior do objeto sendo arrastado (indica um
destino inválido para uma operação de soltar)

13 - fmMousePointerAppStarting Seta com uma ampulheta

14 - fmMousePointerHelp Seta com um ponto de interrogação

15 - fmMousePointerSizeAll Dimensiona todo o cursor (setas apontando para norte,

sul, leste e oeste)

99 - fmMousePointerCustom Usa o ícone especificado pela propriedade MouseIcon

Use esta propriedade para indicar alterações de funcionalidade conforme o ponteiro do mouse passa sobre os
objetos em uma Tela. Por exemplo, a configuração de ampulheta (opção 11 - fmMousePointerHourglass) é útil para
indicar que o usuário precisa esperar algum tempo para que um processo ou operação seja finalizado. Alguns ícones
podem variar, dependendo das configurações do sistema, como os ícones associados aos temas da área de trabalho.
O valor padrão desta propriedade é 0 - fmMousePointerDefault.

[Link].3 Barra de Rolagem

Esta seção contém informações sobre eventos e propriedades do objeto Barra de Rolagem (Scrollbar). Este objeto
não possui métodos associados.

[Link].3.1 Eventos
Esta seção contém informações sobre os eventos do objeto Barra de Rolagem (Scrollbar).
Scroll
Scroll()
Gerado quando o ponteiro da barra de rolagem é movido para alguma direção.

[Link].3.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Barra de Rolagem (Scrollbar).
Delay
Especifica um tempo de espera para o objeto. Esta propriedade afeta a duração de tempo entre eventos Change
consecutivos, gerados quando o usuário clica e mantém pressionada a Barra de Rolagem. O primeiro evento ocorre
imediatamente. O tempo de espera até a segunda ocorrência do evento é de 5 (cinco) vezes o valor especificado
nesta propriedade. Após o tempo inicial, o intervalo entre os eventos é o valor especificado para esta propriedade. O

136 Visualização
valor padrão desta propriedade é 50ms. Isto significa que o objeto inicia o primeiro evento depois de 250 ms, ou 5
(cinco) vezes o valor especificado, e inicia cada evento subsequente depois de 50 ms.
LargeChange
Especifica a quantidade de passos do cursor da Barra de Rolagem. O valor desta propriedade é a quantidade pela
qual a propriedade Value é alterada, quando o usuário clica na área entre a caixa de rolagem e o cursor da Barra de
Rolagem. Qualquer valor inteiro é permitido para esta propriedade, mas o intervalo recomendado é de -32,767 a
+32,767, e este valor deve estar entre os valores determinados nas propriedade Max e Min da Barra de Rolagem.
Max
Esta propriedade é utilizada para determinar o limite máximo do objeto.
Min
Esta propriedade é utilizada para determinar o limite mínimo do objeto.
Orientation
Esta propriedade é utilizada para determinar a orientação do objeto na Tela. Os valores possíveis para esta
propriedade são -1 - fmOrientationAuto: Determina automaticamente a orientação com base nas dimensões do
objeto, isto é, conforme foi criado (padrão), 0 - fmOrientationVertical: O objeto é disposto verticalmente ou 1 -
fmOrientationHorizontal: O objeto é disposto horizontalmente.
ProportionalThumb
Esta propriedade especifica se o tamanho da caixa de rolagem é igual à dimensão do objeto. Se esta propriedade
está configurada para Verdadeiro, a caixa da Barra de Rolagem tem a mesma dimensão do objeto. Caso contrário, se
o objeto é dimensionado, a caixa de rolagem permanece com o tamanho original. O valor padrão desta propriedade
é Verdadeiro.
SmallChange
Esta propriedade especifica a quantidade de movimento que ocorre quando o usuário clica em uma seta de
rolagem no objeto. O valor padrão desta propriedade é 1 (um).
Value
Um número inteiro entre os valores definidos pelas propriedades Min e Max. Indica a posição inicial da barra de
rolagem. Não aceita valores menores que o valor da propriedade Min nem maiores que o valor da propriedade Max.

[Link].4 Botão de Comando

Esta seção contém informações sobre eventos e propriedades do objeto Botão de Comando (CommandButton). Este
objeto não possui métodos associados.

[Link].4.1 Eventos
Esta seção contém informações sobre os eventos do objeto Botão de Comando (CommandButton).
MouseMove
MouseMove()
Ocorre quando o ponteiro do mouse é movimentado sobre o botão de comando.

[Link].4.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Botão de Comando (CommandButton).
Accelerator
Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora é uma tecla que, usada em conjunto com a
tecla ALT, move o foco para o objeto. O valor padrão desta propriedade é uma String vazia.
AutoSize
Esta propriedade ajusta a largura do texto, caso a área disponível ultrapasse o tamanho do objeto. Para o objeto
Botão de Comando (Command Button), quando esta propriedade está configurada para Verdadeiro, a largura do
texto é reajustada para a mesma largura do objeto. O conteúdo do texto é cortado quando excede a área do objeto.
BackStyle
Esta propriedade define o estilo do plano de fundo para os objetos. Os valores possíveis para esta propriedade
são 0 - fmBackStyleTransparent: Define o objeto como transparente, isto é, nenhum fundo deste objeto é desenhado
ou 1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é desenhado (padrão).

Visualização 137
NOTA
Esta propriedade não afeta a transparência de bitmaps. Deve-se usar um editor de imagens como o Paintbrush, por
exemplo, para tornar um bitmap transparente. Nem todos os objetos ActiveX suportam bitmaps transparentes.

Caption
Define o texto que é mostrado no objeto.
Font
Esta propriedade é 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 subpropriedades descritas no tópico Fonte.
Locked
Esta propriedade habilita ou desabilita a edição do objeto. Se esta propriedade está 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 desta propriedade. Para mais detalhes, consulte a propriedade Enabled. O valor
padrão desta propriedade é Falso.
Picture
Esta propriedade especifica a figura (bitmap) atribuída ao objeto. Um arquivo com imagem pode ser selecionado
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 desta propriedade e pressione a tecla
DEL. A tecla BACKSPACE (tecla de espaço do teclado) não remove a figura.
PicturePosition
Esta propriedade 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 figura aparece à esquerda da legenda. A legenda é
alinhada com a parte superior da figura

1 - fmPicturePositionLeftCenter A figura aparece à esquerda da legenda. A legenda é

centralizada relativamente à imagem

2 - fmPicturePositionLeftBottom A figura aparece à esquerda da legenda. A legenda é

alinhada com a parte inferior da figura

3 - fmPicturePositionRightTop A figura aparece à direita da legenda. A legenda é

alinhada com a parte superior da figura

4 - fmPicturePositionRightCenter A figura aparece à direita da legenda. A legenda é

centralizada relativamente à figura

5 - fmPicturePositionRightBottom A figura aparece à direita da legenda. A legenda é

alinhada com a parte inferior da figura

6 - fmPicturePositionAboveLeft A figura aparece acima da legenda. A legenda é alinhada

com a extremidade esquerda da figura

7 - fmPicturePositionAboveCenter A figura aparece acima da legenda. A legenda é

centralizada abaixo da figura (padrão)

8 - fmPicturePositionAboveRight A figura aparece acima da legenda. A legenda é alinhada

com a extremidade direita da figura

9 - fmPicturePositionBelowLeft A figura aparece abaixo da legenda. A legenda é

alinhada com a extremidade esquerda da figura

10 - fmPicturePositionBelowCenter A figura aparece abaixo da legenda. A legenda é

centralizada acima da figura

11 - fmPicturePositionBelowRight A figura aparece abaixo da legenda. A legenda é

alinhada com a extremidade direita da figura

12 - fmPicturePositionCenter A figura aparece no centro do controle. A legenda é

centralizada horizontalmente e verticalmente sobre a
figura

138 Visualização
TakeFocusOnClick
Especifica se o objeto recebe o foco quando clicado. Se esta propriedade está 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.

[Link].5 Botão de Opção

Esta seção contém informações sobre propriedades do objeto Botão de Opção (MdcOptionButton). Este objeto não
possui eventos nem métodos associados.

[Link].5.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Botão de Opção (MdcOptionButton).
Accelerator
Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora é uma tecla que, usada em conjunto com a
tecla ALT, move o foco para o objeto. O valor padrão desta propriedade é uma String vazia.
Alignment
Esta propriedade especifica a posição do objeto relativa à legenda. Os valores possíveis para esta propriedade
são 0 - fmAlignmentLeft: Coloca a legenda à esquerda do objeto ou 1 - fmAligmentRight: Coloca a legenda à
direita do objeto (padrão).
AutoSize
Esta propriedade ajusta a largura do texto, caso a área disponível ultrapasse o tamanho do objeto. Quando esta
propriedade está configurada para Verdadeiro, o texto é redimensionado para coincidir com o tamanho atual do
objeto.
BackStyle
Esta propriedade define o estilo do plano de fundo para os objetos. Os valores possíveis para esta propriedade
são 0 - fmBackStyleTransparent: Define o objeto como transparente, isto é, nenhum fundo deste objeto é
desenhado, ou 1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é desenhado (padrão).

NOTA
Esta propriedade não afeta a transparência de bitmaps. Deve-se usar um editor de imagens como o Paintbrush, por
exemplo, para tornar um bitmap transparente. Nem todos os objetos ActiveX suportam bitmaps transparentes.

Caption
Define o texto que é mostrado no objeto.
Font
Esta propriedade é 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 subpropriedades descritas no tópico Fonte.
GroupName
Esta propriedade é utilizada para criar um grupo de objetos mutuamente exclusivos.

NOTA
Esta propriedade não é utilizada no Elipse E3 e foi mantida por motivos de compatibilidade com a especificação
padrão dos objetos Microsoft Forms.

Locked
Esta propriedade habilita ou desabilita a edição do objeto. Se esta propriedade está 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 desta propriedade. Para mais detalhes, consulte a propriedade Enabled. O valor
padrão desta propriedade é Falso.
Picture
Esta propriedade especifica a figura (bitmap) atribuída ao objeto. Um arquivo com imagem pode ser selecionado
através da Lista de Propriedades ou via scripts, utilizando-se a função LoadPicture para especificar o caminho e o

Visualização 139
nome do arquivo que contém a figura. Para remover a figura, clique no valor desta propriedade e pressione a tecla
DEL. A tecla BACKSPACE (tecla de espaço do teclado) não remove a figura. O script a seguir contém um exemplo de
uso desta propriedade.
Sub CommandButton1_Click()
[Link]("OptionButton1").Picture = LoadPicture("C:\[Link]")
End Sub
PicturePosition
Esta propriedade 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 figura aparece à esquerda da legenda. A legenda é
alinhada com a parte superior da figura

1 - fmPicturePositionLeftCenter A figura aparece à esquerda da legenda. A legenda é

centralizada relativamente à imagem

2 - fmPicturePositionLeftBottom A figura aparece à esquerda da legenda. A legenda é

alinhada com a parte inferior da figura

3 - fmPicturePositionRightTop A figura aparece à direita da legenda. A legenda é

alinhada com a parte superior da figura

4 - fmPicturePositionRightCenter A figura aparece à direita da legenda. A legenda é

centralizada relativamente à figura

5 - fmPicturePositionRightBottom A figura aparece à direita da legenda. A legenda é

alinhada com a parte inferior da figura

6 - fmPicturePositionAboveLeft A figura aparece acima da legenda. A legenda é alinhada

com a extremidade esquerda da figura

7 - fmPicturePositionAboveCenter A figura aparece acima da legenda. A legenda é

centralizada abaixo da figura (padrão)

8 - fmPicturePositionAboveRight A figura aparece acima da legenda. A legenda é alinhada

com a extremidade direita da figura

9 - fmPicturePositionBelowLeft A figura aparece abaixo da legenda. A legenda é

alinhada com a extremidade esquerda da figura

10 - fmPicturePositionBelowCenter A figura aparece abaixo da legenda. A legenda é

centralizada acima da figura

11 - fmPicturePositionBelowRight A figura aparece abaixo da legenda. A legenda é

alinhada com a extremidade direita da figura

12 - fmPicturePositionCenter A figura aparece no centro do controle. A legenda é

centralizada horizontalmente e verticalmente sobre a
figura

SpecialEffect
Esta propriedade 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 aparece plano e possui um destaque na borda,
uma alteração de cor ou ambos

2 - fmButtonEffectSunken O objeto possui uma sombra na parte superior esquerda

e um destaque na parte inferior direita, como se
estivesse afundado na Tela (padrão)

TextAlign
Especifica como o texto é alinhado neste objeto. Os valores possíveis para esta propriedade são 1 -
fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto (padrão), 2 - fmTextAlignCenter: Alinha o
texto com o centro do objeto ou 3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto.

140 Visualização
TripleState
Esta propriedade determina até 3 (três) estados de valores para o objeto. Se esta propriedade está configurada
para Verdadeiro, o usuário pode selecionar entre as 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 ou Verdadeiro.
O valor padrão desta propriedade é Falso.
Value
Indica o valor inicial do objeto e tem um comportamento Booleano, ou seja, se o valor é Verdadeiro, o objeto inicia
selecionado e, do contrário, o 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.

[Link].6 Botão Incremento-Decremento

Esta seção contém informações sobre eventos e propriedades do objeto Botão Incremento-Decremento (Spinbutton).
Este objeto não possui métodos associados.

[Link].6.1 Eventos
Esta seção contém informações sobre os eventos do objeto Botão Incremento-Decremento (Spinbutton).
SpinDown
SpinDown()
Ocorre quando o usuário pressiona a tecla de seta para baixo. Este evento decrementa a propriedade Value do
objeto.
SpinUp
SpinUp()
Ocorre quando o usuário pressiona a tecla de seta para cima. Este evento incrementa a propriedade Value do objeto.

[Link].6.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Botão Incremento-Decremento (Spinbutton).
Delay
Especifica um tempo de espera para o objeto. Esta propriedade afeta a duração de tempo entre os eventos SpinUp,
SpinDown e Change consecutivos, gerados quando o usuário clica e mantém pressionado o botão Incremento-
Decremento. O primeiro evento ocorre imediatamente. O tempo de espera até a segunda ocorrência do evento é de 5
(cinco) vezes o valor especificado nesta propriedade. Após o tempo inicial, o intervalo entre os eventos é o valor
especificado para esta propriedade. O valor padrão desta propriedade é 50 ms. Isto significa que o objeto inicia o
primeiro evento depois de 250 ms, ou 5 (cinco) vezes o valor especificado, e inicia cada evento subsequente depois
de 50 ms.
Max
Esta propriedade é utilizada para determinar o limite máximo do objeto.
Min
Esta propriedade é utilizada para determinar o limite mínimo do objeto.
Orientation
Esta propriedade é utilizada para determinar a orientação do objeto na Tela. Os valores possíveis para esta
propriedade são -1 - fmOrientationAuto: Determina automaticamente a orientação com base nas dimensões do
objeto, isto é, conforme foi criado (padrão), 0 - fmOrientationVertical: O objeto é disposto verticalmente ou 1 -
fmOrientationHorizontal: O objeto é disposto horizontalmente.
SmallChange
Esta propriedade especifica a quantidade de movimento que ocorre quando o usuário clica em uma seta de
rolagem no objeto. O valor padrão desta propriedade é 1 (um).
Value

Visualização 141
 Um 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 da propriedade Min nem maiores que o valor da
propriedade Max.

[Link].7 Botão Liga-Desliga

Esta seção contém informações sobre eventos e propriedades do objeto Botão Liga-Desliga (MdcToggleButton). Este
objeto não possui métodos associados.

[Link].7.1 Eventos
Esta seção contém informações sobre os eventos do objeto Botão Liga-Desliga (MdcToggleButton).
MouseMove
MouseMove()
Ocorre quando o ponteiro do mouse é movimentado sobre o botão Liga-Desliga.

[Link].7.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Botão Liga-Desliga (MdcToggleButton).
Accelerator
Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora é uma tecla que, usada em conjunto com a
tecla ALT, move o foco para o objeto. O valor padrão desta propriedade é uma String vazia.
Alignment
Esta propriedade especifica a posição do objeto, relativa à legenda. Os valores possíveis para esta propriedade
são 0 - fmAlignmentLeft: Coloca a legenda à esquerda do objeto ou 1 - fmAligmentRight: Coloca a legenda à
direita do objeto (padrão). Esta propriedade não pode ser alterada com o objeto ativo.
AutoSize
Esta propriedade ajusta a largura do texto, caso a área disponível ultrapasse o tamanho do objeto. Para o objeto
Botão Liga-Desliga (Toggle Button), quando esta propriedade está configurada para Verdadeiro, o texto é
redimensionado para coincidir com o tamanho atual o objeto, permitindo assim a exibição completa.
BackStyle
Esta propriedade define o estilo do plano de fundo para o objeto. Os valores possíveis para esta propriedade são
0 - fmBackStyleTransparent: Define o objeto como transparente, isto é, nenhum fundo deste objeto é desenhado, ou
1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é desenhado (padrão).

NOTA
Esta propriedade não afeta a transparência de bitmaps. Deve-se usar um editor de imagens como o Paintbrush, por
exemplo, para tornar um bitmap transparente. Nem todos os objetos ActiveX suportam bitmaps transparentes.

Caption
Define o texto que é mostrado no objeto.
Font
Esta propriedade é 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 subpropriedades descritas no tópico Fonte.
GroupName
Esta propriedade é utilizada para criar um grupo de objetos mutuamente exclusivos. Esta propriedade não pode
ser alterada com o objeto ativo.

NOTA
Esta propriedade não é utilizada no Elipse E3 e foi mantida por motivos de compatibilidade com a especificação
padrão dos objetos Microsoft Forms.

Locked
Esta propriedade habilita ou desabilita a edição do objeto. Se esta propriedade está configurada para Verdadeiro,
a edição não é permitida. Caso contrário, é possível editar o objeto. Os valores configurados na propriedade Enabled

142 Visualização
influenciam o comportamento desta propriedade. Para mais detalhes, consulte a propriedade Enabled. O valor
padrão desta propriedade é Falso.
Picture
Esta propriedade especifica a figura (bitmap) atribuída ao objeto. Um arquivo com imagem pode ser selecionado
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 desta propriedade e pressione a tecla
DEL. A tecla BACKSPACE (tecla de espaço do teclado) não remove a figura.
PicturePosition
Esta propriedade especifica a posição da figura atribuída ao objeto em relação à 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 figura aparece à esquerda da legenda. A legenda é
alinhada com a parte superior da figura

1 - fmPicturePositionLeftCenter A figura aparece à esquerda da legenda. A legenda é

centralizada relativamente à imagem

2 - fmPicturePositionLeftBottom A figura aparece à esquerda da legenda. A legenda é

alinhada com a parte inferior da figura

3 - fmPicturePositionRightTop A figura aparece à direita da legenda. A legenda é

alinhada com a parte superior da figura

4 - fmPicturePositionRightCenter A figura aparece à direita da legenda. A legenda é

centralizada relativamente à figura

5 - fmPicturePositionRightBottom A figura aparece à direita da legenda. A legenda é

alinhada com a parte inferior da figura

6 - fmPicturePositionAboveLeft A figura aparece acima da legenda. A legenda é alinhada

com a extremidade esquerda da figura

7 - fmPicturePositionAboveCenter A figura aparece acima da legenda. A legenda é

centralizada abaixo da figura (padrão)

8 - fmPicturePositionAboveRight A figura aparece acima da legenda. A legenda é alinhada

com a extremidade direita da figura

9 - fmPicturePositionBelowLeft A figura aparece abaixo da legenda. A legenda é

alinhada com a extremidade esquerda da figura

10 - fmPicturePositionBelowCenter A figura aparece abaixo da legenda. A legenda é

centralizada acima da figura

11 - fmPicturePositionBelowRight A figura aparece abaixo da legenda. A legenda é

alinhada com a extremidade direita da figura

12 - fmPicturePositionCenter A figura aparece no centro do controle. A legenda é

centralizada horizontalmente e verticalmente sobre a
figura

SpecialEffect
Esta propriedade especifica a aparência de um objeto. Esta propriedade não pode ser alterada com o objeto
ativo. 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 aparece plano e possui um destaque na borda,
uma alteração de cor ou ambos

1 - fmSpecialEffectRaised O objeto possui um destaque na parte superior

esquerda e uma sombra na parte inferior direita. O
objeto parece estar em relevo (padrão)

Visualização 143
 OPÇÃO DESCRIÇÃO
2 - fmSpecialEffectSunken O objeto possui uma sombra na parte superior esquerda
e um destaque na parte inferior direita. O objeto e a
borda parecem estar afundados na Tela

3 - fmSpecialEffectEtched A borda parece estar esculpida ao redor da extremidade

do objeto

6 - fmSpecialEffectBump O objeto possui um ressalto na parte inferior direita e

parece plano na parte superior esquerda

TextAlign
Especifica como o texto é alinhado no objeto. Os valores possíveis para esta propriedade são 1 -
fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto, 2 - fmTextAlignCenter: Alinha o texto ao
centro do objeto (padrão) ou 3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto.
TripleState
Esta propriedade determina até 3 (três) estados de valores para o objeto. Se esta propriedade está configurada
para Verdadeiro, o usuário pode selecionar entre as 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 ou Verdadeiro.
O valor padrão desta propriedade é Falso.
Value
Indica o valor inicial do objeto e tem comportamento Booleano, ou seja, se o valor é Verdadeiro, o objeto inicia
selecionado e, do contrário, o 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.

[Link].8 Caixa de Seleção

Esta seção contém informações sobre propriedades do objeto Caixa de Seleção (MdcCheckBox). Este objeto não
possui eventos nem métodos associados.

[Link].8.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Caixa de Seleção (MdcCheckBox).
Accelerator
Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora é uma tecla que, usada em conjunto com a
tecla ALT, move o foco para o objeto. O valor padrão desta propriedade é uma String vazia.
Alignment
Esta propriedade especifica a posição do objeto relativa à legenda. Os valores possíveis para esta propriedade
são 0 - fmAlignmentLeft: Coloca a legenda à esquerda do objeto ou 1 - fmAligmentRight: Coloca a legenda à
direita do objeto (padrão).
AutoSize
Esta propriedade ajusta a largura do texto caso a área disponível ultrapasse o tamanho do objeto. Quando esta
propriedade está configurada para Verdadeiro, o texto é redimensionado para coincidir com o tamanho atual do
objeto.
BackStyle
Esta propriedade define o estilo do plano de fundo para os objetos. Os valores possíveis para esta propriedade
são 0 - fmBackStyleTransparent: Define o objeto como transparente, isto é, nenhum fundo deste objeto é
desenhado, ou 1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é desenhado (padrão).

NOTA
Esta propriedade não afeta a transparência de bitmaps. Deve-se usar um editor de imagens como o Paintbrush, por
exemplo, para tornar um bitmap transparente. Nem todos os objetos ActiveX suportam bitmaps transparentes.

Caption
Define o texto que é mostrado no objeto.

144 Visualização
Font
Esta propriedade é 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 subpropriedades descritas no tópico Fonte.
GroupName
Esta propriedade é utilizada para criar um grupo de objetos mutuamente exclusivos.

NOTA
Esta propriedade não é utilizada no Elipse E3 e foi mantida por motivos de compatibilidade com a especificação
padrão dos objetos Microsoft Forms.

Locked
Esta propriedade habilita ou desabilita a edição do objeto. Se esta propriedade está 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 desta propriedade. Para mais detalhes, consulte a propriedade Enabled. O valor
padrão desta propriedade é Falso.
Picture
Esta propriedade especifica a figura (bitmap) atribuída ao objeto. Um arquivo com imagem pode ser selecionado
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 desta propriedade e pressione a tecla
DEL. A tecla BACKSPACE (tecla de espaço do teclado) não remove a figura. O script a seguir contém um exemplo de
uso desta propriedade.
Sub CommandButton1_Click()
[Link]("CheckBox1").Picture = LoadPicture("C:\[Link]")
End Sub
PicturePosition
Esta propriedade especifica a posição da figura atribuída ao objeto em relação à 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 figura aparece à esquerda da legenda. A legenda é
alinhada com a parte superior da figura

1 - fmPicturePositionLeftCenter A figura aparece à esquerda da legenda. A legenda é

centralizada relativamente à imagem

2 - fmPicturePositionLeftBottom A figura aparece à esquerda da legenda. A legenda é

alinhada com a parte inferior da figura

3 - fmPicturePositionRightTop A figura aparece à direita da legenda. A legenda é

alinhada com a parte superior da figura

4 - fmPicturePositionRightCenter A figura aparece à direita da legenda. A legenda é

centralizada relativamente à figura

5 - fmPicturePositionRightBottom A figura aparece à direita da legenda. A legenda é

alinhada com a parte inferior da figura

6 - fmPicturePositionAboveLeft A figura aparece acima da legenda. A legenda é alinhada

com a extremidade esquerda da figura

7 - fmPicturePositionAboveCenter A figura aparece acima da legenda. A legenda é

centralizada abaixo da figura (padrão)

8 - fmPicturePositionAboveRight A figura aparece acima da legenda. A legenda é alinhada

com a extremidade direita da figura

9 - fmPicturePositionBelowLeft A figura aparece abaixo da legenda. A legenda é

alinhada com a extremidade esquerda da figura

10 - fmPicturePositionBelowCenter A figura aparece abaixo da legenda. A legenda é

centralizada acima da figura

11 - fmPicturePositionBelowRight A figura aparece abaixo da legenda. A legenda é

alinhada com a extremidade direita da figura

Visualização 145
 OPÇÃO DESCRIÇÃO
12 - fmPicturePositionCenter A figura aparece no centro do controle. A legenda é
centralizada horizontalmente e verticalmente sobre a
figura.

SpecialEffect
Esta propriedade 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 aparece plano e possui um destaque na borda,
uma alteração de cor ou ambos

2 - fmButtonEffectSunken O objeto possui uma sombra na parte superior esquerda

e um destaque na parte inferior direita, como se
estivesse afundado na Tela (padrão)

TextAlign
Especifica como o texto é alinhado neste objeto. Os valores possíveis para esta propriedade são 1 -
fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto (padrão), 2 - fmTextAlignCenter: Alinha o
texto com o centro do objeto ou 3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto.
TripleState
Esta propriedade determina até 3 (três) estados de valores para o objeto. Se esta propriedade está configurada
para Verdadeiro, o usuário pode selecionar entre as 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 ou Verdadeiro.
O valor padrão desta propriedade é Falso.
Value
Indica o valor inicial do objeto e tem comportamento Booleano, ou seja, se o valor é Verdadeiro, o objeto inicia
selecionado e, do contrário, o 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.

[Link].9 Editor de Texto

Esta seção contém informações sobre eventos, métodos e propriedades do objeto Editor de Texto (MdcText).

[Link].9.1 Eventos
Esta seção contém informações sobre os eventos do objeto Editor de Texto (MdcText).
DropButtonClick
DropButtonClick()
Ocorre quando a lista de opções aparece ou desaparece ao se clicar no objeto.

[Link].9.2 Métodos
Esta seção contém informações sobre os métodos do objeto Editor de Texto (MdcText).
Copy
Copy()
Copia para a Área de Transferência um texto previamente selecionado. Utilize o método Paste para colar o texto em
outro local.
Cut
Cut()
Recorta para a Área de Transferência um texto previamente selecionado. Utilize o método Paste para colar o texto em
outro local.

146 Visualização
Paste
Paste()
Insere em um objeto de texto o conteúdo da Área de Transferência.

[Link].9.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Editor de Texto (MdcText).
AutoSize
Esta propriedade ajusta a largura do texto, caso a área disponível ultrapasse o tamanho do objeto. Para o objeto
Editor de Texto (Text Box), quando esta propriedade está configurada para Verdadeiro, a largura do texto é
reajustada para a mesma largura do objeto. O valor padrão desta propriedade é Falso.

NOTA
Recomenda-se evitar o uso desta propriedade com um Editor de Texto vazio, que também utilize as propriedades
Multiline e WordWrap. Quando o usuário digita em um Editor de Texto com estas propriedades ajustadas para
Verdadeiro, automaticamente o objeto se redimensiona como uma caixa longa e estreita, com um caractere de
largura e uma linha de texto de comprimento.

AutoTab
Esta propriedade habilita ou desabilita a tabulação automática no objeto. Se esta propriedade está 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 são atingidos. Por exemplo, quando se quer que
um Editor de Texto exiba dados de estoque que possuam sempre 5 (cinco) caracteres, pode-se usar a propriedade
MaxLength para especificar o número máximo de caracteres a serem introduzidos no objeto e esta propriedade para
tabular automaticamente para o próximo objeto depois que o usuário digitar 5 (cinco) caracteres.
AutoWordSelect
Habilita ou desabilita a seleção automática de palavras no objeto. Se esta propriedade está configurada para
Verdadeiro, a palavra indicada é selecionada no texto mais o espaço seguinte, caso se tenha selecionado parte da
palavra. Caso contrário, somente o caractere indicado na palavra é selecionado.
BackStyle
Esta propriedade define o estilo do plano de fundo para os objetos. Os valores possíveis para esta propriedade
são 0 - fmBackStyleTransparent: Define o objeto como transparente, isto é, nenhum fundo deste objeto é
desenhado, ou 1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é desenhado (padrão).

NOTA
Esta propriedade não afeta a transparência de bitmaps. Deve-se usar um editor de imagens como o Paintbrush, por
exemplo, para tornar um bitmap transparente. Nem todos os objetos ActiveX suportam bitmaps transparentes.

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 de 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
Esta propriedade determina o estilo de borda que é aplicada ao objeto. Os valores possíveis para esta
propriedade são 0 - fmBorderStyleNone: Sem borda (padrão) ou 1 - fmBorderStyleSingle: Com borda simples.
CanPaste
Esta propriedade especifica se a Área de Transferência contém os dados aos quais o objeto dá suporte. Se esta
opção está configurada para Verdadeiro, o objeto pode receber informações coladas da Área de Transferência. Se os
dados da Área de Transferência estão em um formato ao qual o objeto não dá suporte, o valor desta propriedade é
Falso. Por exemplo, ao se tentar colar um bitmap em um objeto que só dê suporte a texto, o valor desta propriedade
é Falso. Esta propriedade é somente de leitura.
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).

Visualização 147
CurTargetX
Retorna a posição horizontal de inserção de um texto no objeto. Esta posição é medida em unidades himétricas, em
que um himetro corresponde a 0,0001 de 1 (um) metro. Pode-se usar esta propriedade e a propriedade 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, esta propriedade 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 é maior que o valor desta
propriedade. Caso contrário, a propriedade CurX é definida como o final da linha do texto. Esta propriedade é
somente de leitura.
CurX
Esta propriedade 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 é, cuja propriedade Multiline está habilitada. O valor de retorno é válido
quando o objeto possui o foco. Pode-se usar a propriedade Multiline e esta propriedade 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. Esta propriedade é definida com este valor se a linha de texto é maior
do que o valor da propriedade CurTargetX. Caso contrário, esta propriedade é definida no fim da linha de texto. Esta
propriedade não pode ser alterada com o objeto ativo.
DragBehavior
Habilita ou desabilita o recurso de arrastar e soltar um texto no conteúdo do objeto. Os valores possíveis para esta
propriedade são 0 - fmDragBehaviorDisabled: Não permite a ação de arrastar e soltar o texto no conteúdo do
objeto (padrão) ou 1 - fmDragBehaviorEnabled: Permite a ação de arrastar e soltar o texto no conteúdo do objeto.

NOTA
Esta propriedade não tem efeito se a propriedade Style está configurada para 2 - fmStyleDropDownList.

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. Os
valores possíveis para esta propriedade são 0 - fmEnterFieldBehaviorSelectAll: Seleciona todo o conteúdo do texto
quando a tecla TAB é pressionada no objeto (padrão) ou 1 - fmEnterFieldBehaviorRecallSelection: A seleção
permanece inalterada.
EnterKeyBehavior
Define o efeito da tecla ENTER no objeto. Se esta propriedade está 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 está configurada para Falso, independente do valor desta propriedade. O atalho de teclado CTRL + ENTER
também depende do valor da propriedade Multiline. Se esta propriedade está configurada para Verdadeiro, ao
pressionar estas teclas uma nova linha é criada na área de edição do texto do objeto, independente do valor desta
propriedade. Se o valor desta propriedade é Falso, as teclas não têm efeito sobre o texto.
Font
Esta propriedade é utilizada para determinar a fonte do objeto Editor de Texto. Esta propriedade não pode ser
utilizada em Associações e contém as subpropriedades descritas no tópico Fonte.
HideSelection
Esta propriedade especifica se o texto selecionado continua em destaque quando um objeto não tem mais o foco.
Se esta propriedade está 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
Esta propriedade especifica o modo IME (Input Method Editor) do objeto Editor de Texto.

NOTA
Esta propriedade se aplica apenas a programas escritos em idiomas asiáticos (chinês simplificado, chinês tradicional,
coreano e japonês) e é ignorada em outros programas. Foi mantida por motivos de compatibilidade com a
especificação padrão dos objetos Microsoft Forms.

148 Visualização
As opções disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade IMEMode
OPÇÃO DESCRIÇÃO
0 - fmIMEModeNoControl Não controla o modo IME (padrão)

1 - fmIMEModeOn Modo IME ativado

2 - fmIMEModeOff Modo IME desativado. Modo inglês

3 - fmIMEModeDisable Modo IME desativado. O usuário não pode ativar o

modo IME pelo teclado

4 - fmIMEModeHiragana Modo IME ativado com modo Hiragana de largura total

5 - fmIMEModeKatakana Modo IME ativado com modo Katakana de largura total

6 - fmIMEModeKatakanaHalf Modo IME ativado com modo Katakana de meia largura

7 - fmIMEModeAlphaFull Modo IME ativado com modo Alfanumérico de largura

total

8 - fmIMEModeAlpha Modo IME ativado com modo Alfanumérico de meia

largura

9 - fmIMEModeHangulFull Modo IME ativado com modo Hangul de largura total

10 - fmIMEModeHangul Modo IME ativado com modo Hangul de meia largura

11 - fmIMEModeHanziFull Modo IME ativado com modo Hanzi de largura total

12 - fmIMEModeHanzi Modo IME ativado com modo Hanzi de meia largura

IntegralHeight
Esta propriedade ajusta a altura da área de edição do texto, caso a área disponível ultrapasse o tamanho do
objeto. Se esta propriedade está 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 o tamanho original. Se os textos são maiores que o espaço disponível, estes
não são exibidos no objeto.
LineCount
Esta propriedade retorna o número de linhas do objeto. Esta propriedade é somente de leitura.
Locked
Esta propriedade habilita ou desabilita a edição do objeto. Se esta propriedade está 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 desta propriedade. Para mais detalhes, consulte a propriedade Enabled. O valor
padrão desta propriedade é Falso.
MaxLength
Esta propriedade determina o número máximo de caracteres no objeto. Se esta propriedade está configurada com
o valor 0 (zero), não há limite de caracteres no objeto.
Multiline
Esta propriedade indica se o texto tem múltiplas linhas (Verdadeiro) ou é uma caixa de texto simples (Falso). Isto
pode ser visualizado quando o Elipse E3 Viewer está em execução. O valor padrão desta propriedade é Falso.
PasswordChar
Converte o texto do objeto para um caractere especial, configurado nesta propriedade. Utilize esta propriedade
para proteger informações sensíveis, como senhas ou códigos de segurança. O valor desta propriedade é o
caractere, normalmente um asterisco, que aparece em um objeto, ao invés dos caracteres reais que o usuário digita.
Se um caractere não é especificado, o controle exibe os caracteres digitados pelo usuário.
ScrollBars
Especifica se o objeto possui barras de rolagem verticais, horizontais ou ambas. Os valores possíveis para esta
propriedade são 0 - fmScrollBarsNone: Não exibe barras de rolagem (padrão), 1 - fmScrollBarsHorizontal: Exibe
uma barra de rolagem horizontal, 2 - fmScrollBarsVertical: Exibe uma barra de rolagem vertical ou 3 -
fmScrollBarsBoth: Exibe tanto a barra de rolagem vertical quanto a barra de rolagem horizontal.

Visualização 149
SelectionMargin
Habilita ou desabilita a margem de seleção do objeto. Se esta propriedade está 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 esta propriedade está configurada para Verdadeiro quando o objeto é impresso, a margem de seleção também
é impressa.

SelLength
Retorna o número de caracteres selecionados no objeto. Esta propriedade não pode ser alterada com o objeto
ativo.
SelStart
Indica o ponto inicial do texto selecionado ou o ponto de inserção, se nenhum texto é selecionado. Esta propriedade
não pode ser alterada com o objeto ativo.
SelText
Retorna o texto selecionado no objeto. Esta propriedade não pode ser alterada com o objeto ativo.
SpecialEffect
Esta propriedade 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 aparece plano e possui um destaque na borda,
uma alteração de cor ou ambos

1 - fmSpecialEffectRaised O objeto possui um destaque na parte superior

esquerda e uma sombra na parte inferior direita. O
objeto parece estar em relevo

2 - fmSpecialEffectSunken O objeto possui uma sombra na parte superior esquerda

e um destaque na parte inferior direita. O objeto e a
borda parecem estar afundados na Tela (padrão)

3 - fmSpecialEffectEtched A borda parece estar esculpida ao redor da extremidade

do objeto

6 - fmSpecialEffectBump O objeto possui um ressalto na parte inferior direita e

parece plano na parte superior esquerda

TabKeyBehavior
Determina se as tabulações são permitidas na região de edição. Se esta propriedade está 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 não pode ser alterada com o objeto ativo.
TextAlign
Especifica como o texto é alinhado no objeto. Os valores possíveis para esta propriedade são 1 -
fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto (padrão), 2 - fmTextAlignCenter: Alinha o
texto com o centro do objeto ou 3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto.
TextLength
Retorna o número de caracteres digitados no objeto. Esta propriedade é somente de leitura.
Value
Este é o texto na área de edição. Esta propriedade é do tipo Variant, e pode assumir valores de todo e qualquer
tipo, tais como Date, Boolean, ou String, entre outros.
WordWrap

150 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.

[Link].10 Fonte
Esta seção contém informações sobre propriedades do objeto Fonte (Font) retornado pelas propriedades Font
dos objetos MS Forms, com exceção dos objetos Barra de Rolagem e Botão Incremento-Decremento. Este objeto não
possui eventos nem métodos associados.

[Link].10.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Fonte (Font) retornado pelas propriedades Font
dos objetos MS Forms, com exceção dos objetos Barra de Rolagem e Botão Incremento-Decremento.
Bold
Esta propriedade indica se o texto do objeto MS Forms está em negrito.
Charset
Esta propriedade indica o conjunto de caracteres disponível para a fonte do objeto MS Forms. Os valores possíveis
para esta propriedade estão descritos na tabela a seguir.
Valores disponíveis para a propriedade Charset
VALOR PÁGINA DE CÓDIGO NOME DESCRIÇÃO
0 1252 ANSI_CHARSET ANSI (American National
Standards Institute)

1 -- DEFAULT_CHARSET Padrão (mostra o conjunto

de caracteres disponível na
Fonte)

2 -- SYMBOL_CHARSET Símbolos

128 932 SHIFTJIS_CHARSET Japonês (Shift-JIS)

129 949 HANGUL_CHARSET Coreano

134 936 GB2312_CHARSET Chinês Simplificado (GBK)

136 950 CHINESEBIG5_CHARSET Chinês Tradicional (Big5)

161 1253 GREEK_CHARSET Grego

162 1254 TURKISH_CHARSET Turco

177 1255 HEBREW_CHARSET Hebraico

178 1256 ARABIC_CHARSET Árabe

186 1257 BALTIC_CHARSET Báltico

204 1251 RUSSIAN_CHARSET Cirílico

222 874 THAI_CHARSET Tailandês

238 1250 EE_CHARSET Centro-Europeu

255 -- OEM_CHARSET OEM (Original Equipment

Manufacturer)

Italic
Esta propriedade indica se o texto do objeto MS Forms está em itálico.
Name
Esta propriedade indica o nome da fonte do objeto MS Forms.
Size
Esta propriedade indica o tamanho, em pontos, da fonte do texto do objeto MS Forms.
Strikethrough
Esta propriedade indica se o texto do objeto MS Forms usa o efeito de tachado.

Visualização 151
Underline
Esta propriedade indica se o texto do objeto MS Forms usa o efeito de sublinhado.
Weight
Esta propriedade indica a variação do efeito de negrito na fonte do objeto MS Forms, ou seja, da propriedade Bold.
Os valores para esta propriedade podem variar entre 0 (zero, não interfere no efeito de negrito) e 1000.

[Link].11 Lista
Esta seção contém informações sobre métodos e propriedades do objeto Lista (MdcList). Este objeto não possui
eventos associados.

[Link].11.1 Métodos
Esta seção contém informações sobre os métodos do objeto Lista (MdcList).
AddItem
AddItem([pvargItem], [pvargIndex])
Este método é utilizado para adicionar itens a uma Lista. O parâmetro pvargItem é uma String que contém o texto que
é adicionado à lista e, se omitido, é acrescentada uma String em branco. O parâmetro pvargIndex é o índice do texto
na lista e, se omitido, o valor do parâmetro pvargItem é adicionado como último item da lista. O script a seguir
contém um exemplo de uso deste método.
Sub CommandButton1_Click()
EntryCount = EntryCount + 1
[Link](EntryCount & " - Selection")
End Sub
Clear
Clear()
Limpa o texto do objeto.
RemoveItem
RemoveItem(pvargIndex)
Remove itens da 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. O script a seguir contém um
exemplo de uso deste método.
Sub CommandButton2_Click()
[Link]
' Verifica se a lista contém dados selecionados
If [Link] >= 1 Then
' Se não há nenhuma seleção,
' seleciona o último dado da lista.
If [Link] = -1 Then
[Link] = [Link] – 1
End If
[Link]([Link])
End If
End Sub

[Link].11.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Lista (MdcList).
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 de 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
Esta propriedade determina o estilo de borda que é aplicada ao objeto. Os valores possíveis para esta
propriedade são 0 - fmBorderStyleNone: Sem borda (padrão) ou 1 - fmBorderStyleSingle: Com borda simples
BoundColumn
Determina a coluna da lista onde os dados são armazenados. Por exemplo, se cada linha contém 8 (oito) itens e
esta propriedade é igual a 3 (três), o sistema armazena as informações na terceira coluna da linha atualmente

152 Visualização
selecionada. Se o valor desta propriedade é igual a 0 (zero), este valor é passado para a propriedade ListIndex do
objeto. Se o valor desta propriedade é igual a 1 (um) ou superior, o dado indicado é atribuído à coluna referente ao
valor especificado nesta propriedade. As colunas são numeradas a partir de 1 (um).

NOTA
Esta propriedade não tem efeito no Elipse E3 e foi mantida por motivos de compatibilidade com a especificação
padrão dos objetos Microsoft Forms.

Column
Especifica a linha e coluna no objeto. Se somente o valor de coluna é especificado, esta propriedade lê ou escreve a
coluna especificada na linha atual do objeto. Por exemplo, "[Link](3)" lê ou escreve a terceira
coluna do objeto. Esta propriedade não pode ser alterada com o objeto ativo.
ColumnCount
Esta propriedade especifica o número de colunas do objeto. Configurar esta propriedade com o valor 0 (zero) não
exibe nenhuma coluna, e configurar esta propriedade com o valor -1 (menos um) exibe todas as colunas disponíveis.
O valor padrão desta propriedade é 1 (um).
ColumnHeads
Esta propriedade habilita ou desabilita a exibição do título das colunas no objeto. Se esta propriedade está
configurada para Verdadeiro, o título é mostrado. Caso contrário, o título das colunas não é mostrado. O valor
padrão desta propriedade é Falso.
ColumnWidths
Esta propriedade é utilizada para especificar a largura da coluna do objeto, em pontos. Configurar esta propriedade
com o valor -1 (menos um) ou em branco indica que a largura é 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 nesta 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 primeira coluna possui 90 pontos (1,25 polegada), a
segunda coluna possui 72 pontos (uma polegada) e a
terceira coluna possui 90 pontos

6 cm;0;6 cm A primeira coluna possui 6 (seis) centímetros, a segunda

coluna está oculta e a terceira coluna possui 6 (seis)
centímetros. Como parte da terceira coluna é visível, uma
barra de rolagem horizontal aparece

1,5 pol;0;2,5 pol A primeira coluna possui 1,5 polegadas, a segunda

coluna está oculta e a terceira coluna possui 2,5
polegadas

2 pol;;2 pol A primeira coluna possui 2 (duas) polegadas, a segunda

coluna possui 1 (uma) polegada (padrão) e a terceira
coluna possui 2 (duas) polegadas. Como somente
metade da terceira coluna é visível, uma barra de
rolagem horizontal aparece

(Vazio) Todas as três colunas possuem a mesma largura, ou 1,33

polegadas. O valor padrão desta propriedade é vazio,
ou seja, o Elipse E3 utiliza o valor padrão do sistema

Font
Esta propriedade é utilizada para determinar a fonte do objeto Lista. Esta propriedade não pode ser utilizada em
Associações e contém as subpropriedades descritas no tópico Fonte.
IMEMode
Esta propriedade especifica o modo IME (Input Method Editor) do objeto Lista.

Visualização 153
NOTA
Esta propriedade se aplica apenas a programas escritos em idiomas asiáticos (chinês simplificado, chinês tradicional,
coreano e japonês) e é ignorada em outros programas. Foi mantida por motivos de compatibilidade com a
especificação padrão dos objetos Microsoft Forms.

As opções disponíveis para esta propriedade estão descritas na tabela a seguir.

Opções disponíveis para a propriedade IMEMode
OPÇÃO DESCRIÇÃO
0 - fmIMEModeNoControl Não controla o modo IME (padrão)

1 - fmIMEModeOn Modo IME ativado

2 - fmIMEModeOff Modo IME desativado. Modo inglês

3 - fmIMEModeDisable Modo IME desativado. O usuário não pode ativar o

modo IME pelo teclado

4 - fmIMEModeHiragana Modo IME ativado com modo Hiragana de largura total

5 - fmIMEModeKatakana Modo IME ativado com modo Katakana de largura total

6 - fmIMEModeKatakanaHalf Modo IME ativado com modo Katakana de meia largura

7 - fmIMEModeAlphaFull Modo IME ativado com modo Alfanumérico de largura

total

8 - fmIMEModeAlpha Modo IME ativado com modo Alfanumérico de meia

largura

9 - fmIMEModeHangulFull Modo IME ativado com modo Hangul de largura total

10 - fmIMEModeHangul Modo IME ativado com modo Hangul de meia largura

11 - fmIMEModeHanziFull Modo IME ativado com modo Hanzi de largura total

12 - fmIMEModeHanzi Modo IME ativado com modo Hanzi de meia largura

IntegralHeight
Esta propriedade ajusta a altura da área de edição do texto, caso a área disponível ultrapasse o tamanho do
objeto. Se esta propriedade está 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 o 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 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 não pode ser alterada
com o objeto ativo.
ListCount
Retorna o número de itens contidos na lista do objeto. Esta propriedade é somente de leitura.
ListIndex
Identifica o item atualmente selecionado na lista, chamado de índice. Os valores desta propriedade vão de -1
(menos um) ao número total de linhas em uma lista menos um, isto é, o valor da propriedade ListCount menos 1
(um). Quando nenhuma linha é selecionada, esta propriedade retorna -1 (menos um). Quando o usuário seleciona uma
linha em uma Lista de Seleção, o sistema define o valor desta propriedade. O valor desta propriedade da primeira
linha de uma lista é 0 (zero), o valor da segunda linha é 1 (um), e assim por diante. Esta propriedade não pode ser
alterada com o objeto ativo.
ListStyle
Esta propriedade determina o estilo da lista do objeto. Os valores possíveis para esta propriedade são 0 -
fmListStylePlain: Listagem com os itens do plano de fundo em destaque (padrão) ou 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

154 Visualização
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
A opção 1 - fmListStyleOption só pode ser habilitada se a propriedade MultiSelect está configurada com o valor 1
- fmMultiSelectMulti.

Locked
Esta propriedade habilita ou desabilita a edição do objeto. Se esta propriedade está 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 desta propriedade. Para mais 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. Os valores
possíveis para esta propriedade são 0 - fmMatchEntryFirstLetter: Procura pela entrada de texto que coincida com o
primeiro caractere digitado no objeto. Se a mesma letra é digitada repetidamente, passa para a próxima entrada de
texto que comece com esta letra, e assim por diante (padrão), 1 - fmMatchEntryComplete: Conforme cada caractere
é digitado, o objeto procura por uma entrada de texto que coincida com os caracteres digitados ou 2 -
fmMatchEntryNone: Não realiza a procura no objeto.
MultiSelect
Esta propriedade indica se o objeto permite múltiplas seleções. Os valores possíveis para esta propriedade são 0 -
fmMultiSelectSingle: Somente um item pode ser selecionado (padrão), 1 - fmMultiSelectMulti: Permite selecionar
um item através da barra de espaço ou clique do mouse, permitindo que se marque ou desmarque um item na lista,
ou 2 - fmMultiSelectExtended: Permite selecionar um item através da tecla SHIFT, clicando com o mouse ou
pressionando a tecla SHIFT e uma das teclas de direção, estendendo a seleção para o item atual. Pressionando a tecla
CTRL e clicando com o mouse, marca ou desmarca um item.
Selected
Seleciona ou desfaz a seleção de um item, e verifica se um item está selecionado, quando a propriedade Multiline
está configurada com o valor Verdadeiro. Para saber se um determinado item está selecionado, o índice do item a ser
consultado deve ser passado e a propriedade retorna se o item está selecionado ou não. Desta forma, é possível
identificar quais itens estão selecionados quando o usuário selecionar mais de um item. Esta propriedade não pode
ser alterada com o objeto ativo. Quando o usuário não está utilizando múltiplas seleções, recomenda-se que sejam
usadas as propriedades Value ou ListIndex.
SpecialEffect
Esta propriedade 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 aparece plano e possui um destaque na borda,
uma alteração de cor ou ambos

1 - fmSpecialEffectRaised O objeto possui um destaque na parte superior

esquerda e uma sombra na parte inferior direita. O
objeto parece estar em relevo

2 - fmSpecialEffectSunken O objeto possui uma sombra na parte superior esquerda

e um destaque na parte inferior direita. O objeto e a
borda parecem estar afundados na Tela (padrão)

3 - fmSpecialEffectEtched A borda parece estar esculpida ao redor da extremidade

do objeto

6 - fmSpecialEffectBump O objeto possui um ressalto na parte inferior direita e

parece plano na parte superior esquerda

Text
Retorna o texto da opção selecionada. Esta propriedade não pode ser alterada com o objeto ativo.

Visualização 155
TextAlign
Especifica como o texto é alinhado no objeto. Os valores possíveis para esta propriedade são 1 -
fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto (padrão), 2 - fmTextAlignCenter: Alinha o
texto com o centro do objeto ou 3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto.
TextColumn
Esta propriedade identifica a coluna no objeto. Os valores para esta propriedade vão de -1 (menos um) ao número
de colunas na lista. O valor desta propriedade para a primeira coluna é 1 (um), o valor da segunda coluna é 2 (dois), e
assim por diante. A configuração desta propriedade em 0 (zero) exibe os valores para a propriedade ListIndex. A
configuração desta propriedade como -1 (menos um) exibe a primeira coluna que possui o valor da propriedade
ColumnWidths maior do que 0 (zero).
TopIndex
Esta propriedade 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.
Value
Este é o valor da propriedade BoundColumn das linhas atualmente selecionadas. Esta propriedade não tem efeito
no Elipse E3 e foi mantida por motivos de compatibilidade com a especificação padrão dos objetos Microsoft Forms.

[Link].12 Lista de Seleção

Esta seção contém informações sobre eventos, métodos e propriedades do objeto Lista de Seleção (MdcCombo).

[Link].12.1 Eventos
Esta seção contém informações sobre os eventos do objeto Lista de Seleção (MdcCombo).
DropButtonClick
DropButtonClick()
Ocorre quando a Lista de Opções aparece ou desaparece ao se clicar no objeto.

[Link].12.2 Métodos
Esta seção contém informações sobre os métodos do objeto Lista de Seleção (MdcCombo).
AddItem
AddItem([pvargItem], [pvargIndex])
Este método é utilizado para se adicionar itens a uma Lista de Seleção. O parâmetro pvargItem é uma String que
contém o texto que é adicionado na lista. Se omitido, é acrescentada uma String em branco. O parâmetro pvargIndex
é o índice do texto na lista. Se omitido, o valor do parâmetro pvargItem é adicionado como último item da lista. O
script a seguir contém um exemplo de uso deste método.
Sub CommandButton1_Click()
EntryCount = EntryCount + 1
[Link](EntryCount & " - Selection")
End Sub
Clear
Clear()
Limpa o texto do objeto.
Copy
Copy()
Copia o texto previamente selecionado para a Área de Transferência. Utilize o método Paste para colar o texto no
local indicado. O script a seguir contém um exemplo de uso deste método.
Sub CommandButton1_Click()
[Link]("ComboBox1").Copy()
End Sub
Cut
Cut()
Recorta o texto previamente selecionado para a Área de Transferência. Utilize o método Paste para colar o texto no
local indicado. O script a seguir contém um exemplo de uso deste método.

156 Visualização
 Sub CommandButton1_Click()
[Link]("ComboBox1").Cut()
End Sub
DropDown
DropDown()
Este método abre a lista de itens de uma Lista de Seleção. A chamada deste método tem o mesmo efeito que clicar,
em tempo de execução, no botão com a seta ao lado direito do objeto. O script a seguir contém um exemplo de uso
deste método.
Sub CommandButton1_Click()
Dim ComboBox1
[Link] "Abacaxi"
[Link] "Morango"
[Link] "Uva"
[Link] "Laranja"
[Link]()
End Sub
Paste
Paste()
Insere no objeto o conteúdo da Área de Transferência. O script a seguir contém um exemplo de uso deste método.
Sub CommandButton1_Click()
[Link]("ComboBox1").Paste()
End Sub
RemoveItem
RemoveItem(pvargIndex)
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. O script a
seguir contém um exemplo de uso deste método.
Sub CommandButton2_Click()
[Link]
' Verifica se a lista contém dados selecionados
If [Link] >= 1 Then
' Se não há nenhuma seleção,
' selecione o último dado da lista.
If [Link] = -1 Then
[Link] = [Link] – 1
End If
[Link]([Link])
End If
End Sub

[Link].12.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Lista de Seleção (MdcCombo).
AutoSize
Esta propriedade ajusta a largura do texto, caso a área disponível ultrapasse o tamanho do objeto. Para o objeto
Lista de Seleção (Combo), quando esta propriedade está configurada para Verdadeiro, a largura do texto é
reajustada para a mesma largura do objeto.
AutoTab
Esta propriedade habilita ou desabilita a tabulação automática no objeto. Se esta propriedade está 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, utilizando a propriedade MaxLength, o foco se move automaticamente para o
próximo objeto da ordem de tabulação, quando estes caracteres são atingidos. Por exemplo, para que uma Lista de
Seleção exiba dados de estoque que possuam sempre 5 (cinco) caracteres, pode-se usar a propriedade MaxLength
para especificar o número máximo de caracteres a serem introduzidos no objeto e esta propriedade para tabular
automaticamente para o próximo objeto depois que o usuário digitar 5 (cinco) caracteres.
AutoWordSelect
Habilita ou desabilita a seleção automática de palavras no objeto. Se esta propriedade está configurada para
Verdadeiro, a palavra indicada é selecionada no texto mais o espaço seguinte, caso se tenha selecionada parte da
palavra. Caso contrário, somente o caractere indicado na palavra é selecionado.

Visualização 157
BackStyle
Esta propriedade define o estilo do plano de fundo para este objeto. Os valores possíveis para esta propriedade
são 0 - fmBackStyleTransparent: Define o objeto como transparente, isto é, nenhum fundo deste objeto é
desenhado, ou 1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é desenhado (padrão).

NOTA
Esta propriedade não afeta a transparência de bitmaps. Deve-se usar um editor de imagens como o Paintbrush, por
exemplo, para tornar um bitmap transparente. Nem todos os objetos ActiveX suportam bitmaps transparentes.

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 edição. Para que esta propriedade seja aplicável, é necessário que a
propriedade BorderStyle esteja configurada com o valor 1 - fmBorderStyleSingle. O valor padrão desta propriedade
é preto (RGB(0, 0, 0)).
BorderStyle
Esta propriedade determina o estilo de borda que é aplicada ao objeto. Os valores possíveis para esta
propriedade são 0 - fmBorderStyleNone: Sem borda (padrão) ou 1 - fmBorderStyleSingle: Com borda simples.
BoundColumn
Determina a coluna da lista onde os dados são armazenados. Por exemplo, se cada linha contém 8 (oito) itens e
esta propriedade é igual a 3 (três), o objeto armazena as informações na terceira coluna da linha atualmente
selecionada. Se o valor é igual a 0 (zero), este valor é passado para a propriedade ListIndex do objeto. Se o valor é
igual a 1 (um) ou superior, o dado indicado é atribuído à coluna referente ao valor especificado nesta propriedade. As
colunas são numeradas a partir de 1 (um).

NOTA
Esta propriedade não tem efeito no Elipse E3 e foi mantida por motivos de compatibilidade com a especificação
padrão dos objetos Microsoft Forms.

CanPaste
Esta propriedade especifica se a Área de Transferência contém os dados aos quais o objeto dá suporte. Se esta
propriedade está configurada com o valor Verdadeiro, o objeto pode receber informações coladas da Área de
Transferência. Se os dados da Área de Transferência estão em um formato ao qual o objeto não dá suporte, o valor
desta propriedade é Falso. Por exemplo, ao tentar colar um bitmap em um objeto que só dê suporte a texto, o valor
desta propriedade é Falso. Esta propriedade é somente de leitura.
Column
Especifica a linha e a coluna no objeto. Ao especificar somente o valor de coluna, esta propriedade lê ou escreve a
coluna especificada na linha atual do objeto. Por exemplo, "[Link](3)" lê ou escreve a terceira
coluna do objeto. Esta propriedade não pode ser alterada com o objeto ativo.
ColumnCount
Esta propriedade especifica o número de colunas do objeto. Configurar esta propriedade com o valor 0 (zero) não
exibe nenhuma coluna, e configurar esta propriedade com o valor -1 (menos um) exibe todas as colunas disponíveis.
O valor padrão desta propriedade é 1 (um).
ColumnHeads
Esta propriedade habilita ou desabilita a exibição do título das colunas no objeto. Se esta propriedade está
configurada para Verdadeiro, o título é mostrado. Caso contrário, o título das colunas não é mostrado. O valor
padrão desta propriedade é Falso.
ColumnWidths
Esta propriedade é utilizada para especificar a largura da coluna do objeto, em pontos. Um valor igual a -1 (menos
um) ou em branco indica que a largura é 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 nesta propriedade ou utilizar algum dos valores descritos na tabela a seguir.

158 Visualização
 Opções disponíveis para a propriedade ColumnWidths
OPÇÃO DESCRIÇÃO
90;72;90 A primeira coluna possui 90 pontos (1,25 polegada), a
segunda coluna possui 72 pontos (uma polegada) e a
terceira coluna possui 90 pontos

6 cm;0;6 cm A primeira coluna possui 6 (seis) centímetros, a segunda

coluna está oculta e a terceira coluna possui 6 (seis)
centímetros. Como parte da terceira coluna é visível, uma
barra de rolagem horizontal aparece

1,5 pol;0;2,5 pol A primeira coluna possui 1,5 polegadas, a segunda

coluna está oculta e a terceira coluna possui 2,5
polegadas

2 pol;;2 pol A primeira coluna possui 2 (duas) polegadas, a segunda

coluna possui 1 (uma) polegada (padrão) e a terceira
coluna possui 2 (duas) polegadas. Como somente
metade da terceira coluna é visível, uma barra de
rolagem horizontal aparece

(Vazio) Todas as três colunas possuem a mesma largura, ou 1,33

polegadas. O valor padrão desta propriedade é vazio,
ou seja, o Elipse E3 utiliza o valor padrão do sistema

CurTargetX
Retorna a posição horizontal de inserção de um texto no objeto. Esta posição é medida em unidades himétricas, em
que um himetro é igual a 0,0001 de 1 (um) metro. Pode-se usar esta propriedade e a propriedade 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, esta propriedade 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 é maior que o valor desta
propriedade. Caso contrário, a propriedade CurX é definida como o final da linha do texto. Esta propriedade é
somente de leitura.

NOTA
Esta propriedade não tem efeito no Elipse E3 e foi mantida por motivos de compatibilidade com a especificação
padrão dos objetos Microsoft Forms.

CurX
Esta propriedade 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 esta propriedade 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. Esta propriedade é definida com este valor se a linha de
texto é maior do que o valor da propriedade CurTargetX. Caso contrário, o valor desta propriedade é definido no
fim da linha de texto. Esta propriedade é somente de leitura.
DragBehavior
Habilita ou desabilita o recurso de arrastar e soltar um texto no conteúdo do objeto. Os valores possíveis para
esta propriedade são 0 - fmDragBehaviorDisabled: Não permite a ação de arrastar e soltar o texto no conteúdo do
objeto (padrão) ou 1 - fmDragBehaviorEnabled: Permite a ação de arrastar e soltar o texto no conteúdo do objeto.

NOTA
Esta propriedade não tem efeito se a propriedade Style está configurada com o valor 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.

Visualização 159
 Opções disponíveis para a propriedade DropButtonStyle
OPÇÃO DESCRIÇÃO
0 - fmDropButtonStylePlain Exibe um botão plano, sem símbolo

1 - fmDropButtonStyleArrow Exibe um seta para baixo (padrão)

2 - fmDropButtonStyleEllipsis Exibe reticências

3 - fmDropButtonStyleReduce Exibe uma reta horizontal como um caractere sublinhado

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. Os
valores possíveis para esta propriedade são 0 - fmEnterFieldBehaviorSelectAll: Seleciona todo o conteúdo do texto
quando a tecla TAB é pressionada no objeto (padrão) ou 1 - fmEnterFieldBehaviorRecallSelection: A seleção
permanece inalterada.
Font
Esta propriedade é utilizada para determinar a fonte do objeto Lista de Seleção. Esta propriedade não pode ser
utilizada em Associações e contém as subpropriedades descritas no tópico Fonte.
HideSelection
Esta propriedade especifica se o texto selecionado continua em destaque quando um objeto não tem mais o foco.
Se esta propriedade está configurada para Verdadeiro, o texto selecionado somente se mantém em destaque caso o
objeto tenha o foco. Caso contrário, o texto selecionado sempre aparece em destaque, independente do foco no
objeto. O valor padrão desta propriedade é Verdadeiro.
IMEMode
Esta propriedade especifica o modo IME (Input Method Editor) do objeto Lista de Seleção.

NOTA
Esta propriedade se aplica apenas a programas escritos em idiomas asiáticos (chinês simplificado, chinês tradicional,
coreano e japonês) e é ignorada em outros programas. Foi mantida por motivos de compatibilidade com a
especificação padrão dos objetos Microsoft Forms.

As opções disponíveis para esta propriedade estão descritas na tabela a seguir.

Opções disponíveis para a propriedade IMEMode
OPÇÃO DESCRIÇÃO
0 - fmIMEModeNoControl Não controla o modo IME (padrão)

1 - fmIMEModeOn Modo IME ativado

2 - fmIMEModeOff Modo IME desativado. Modo inglês

3 - fmIMEModeDisable Modo IME desativado. O usuário não pode ativar o

modo IME pelo teclado

4 - fmIMEModeHiragana Modo IME ativado com modo Hiragana de largura total

5 - fmIMEModeKatakana Modo IME ativado com modo Katakana de largura total

6 - fmIMEModeKatakanaHalf Modo IME ativado com modo Katakana de meia largura

7 - fmIMEModeAlphaFull Modo IME ativado com modo Alfanumérico de largura

total

8 - fmIMEModeAlpha Modo IME ativado com modo Alfanumérico de meia

largura

9 - fmIMEModeHangulFull Modo IME ativado com modo Hangul de largura total

10 - fmIMEModeHangul Modo IME ativado com modo Hangul de meia largura

11 - fmIMEModeHanziFull Modo IME ativado com modo Hanzi de largura total

12 - fmIMEModeHanzi Modo IME ativado com modo Hanzi de meia largura

160 Visualização
LineCount
Esta propriedade retorna o número de linhas do objeto. Esta propriedade é somente de leitura.
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 não pode ser alterada
com o objeto ativo.
ListCount
Retorna o número de itens contidos na lista do objeto. Esta propriedade é somente de leitura.
ListIndex
Identifica o item atualmente selecionado na lista, chamado de índice. Os valores desta propriedade vão de -1
(menos um) ao número total de linhas em uma lista menos um, isto é, o valor da propriedade ListCount menos 1
(um). Quando nenhuma linha é selecionada, esta propriedade retorna -1 (menos um). Quando o usuário seleciona uma
linha em uma Lista de Seleção, o sistema define o valor desta propriedade. O valor desta propriedade da primeira
linha de uma lista é 0 (zero), o valor da segunda linha é 1 (um) e assim por diante. Esta propriedade não pode ser
alterada com o objeto ativo.
ListRows
Esta propriedade determina o número máximo de linhas na lista do objeto. O valor padrão desta propriedade é 8
(oito).
ListStyle
Esta propriedade determina o estilo da lista do objeto. Os valores possíveis para esta propriedade são 0 -
fmListStylePlain: Listagem com os itens do plano de fundo em destaque (padrão) ou 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.
ListWidth
Esta propriedade determina a largura da lista do objeto. O valor padrão desta propriedade é 0 (zero).
Locked
Esta propriedade habilita ou desabilita a edição do objeto. Se esta propriedade está 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 desta propriedade. Para mais 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 do texto, a linha é selecionada e o conteúdo da coluna é exibido. Os valores
possíveis para esta propriedade são 0 - fmMatchEntryFirstLetter: Procura pela entrada de texto que coincida com o
primeiro caractere digitado no objeto. Se a mesma letra é digitada repetidamente, passa 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 (padrão) ou 2 -
fmMatchEntryNone: Não realiza a procura no objeto.
MatchFound
Indica se o texto que o usuário digitou no objeto coincide com qualquer entrada na lista. Se esta propriedade está
configurada para Verdadeiro, o conteúdo da propriedade Value coincide com um dos registros na lista. Caso
contrário, o conteúdo da propriedade Value não coincide com nenhum dos registros na lista (padrão). Esta
propriedade é somente de leitura, e não é aplicável quando a propriedade MatchEntry é definida com o valor 2
(dois, fmMatchEntryNone). O valor padrão desta propriedade é Falso.
MatchRequired
Especifica se o texto digitado deve ou não coincidir com os itens existentes na Lista de Seleção. Se esta propriedade
está configurada para Verdadeiro, o usuário não pode sair da Lista de Seleção até que o texto inserido coincida com
um item existente do objeto. Caso contrário, o texto inserido na Lista de Seleção pode ser diferente de todos os
dados existentes na Lista.

Visualização 161
MaxLength
Esta propriedade determina o número máximo de caracteres no objeto. Se esta propriedade está configurada com
o valor 0 (zero), não há limite de caracteres no objeto.
SelectionMargin
Habilita ou desabilita a margem de seleção do objeto. Se esta propriedade está configurada para Verdadeiro, o
texto é selecionado ao se clicar na margem do objeto. Caso contrário, o texto não é selecionado ao se clicar na
margem.

NOTA
Se esta propriedade está configurada para Verdadeiro quando o objeto é impresso, a margem de seleção também
é impressa.

SelLength
Retorna o número de caracteres selecionados no objeto. Esta propriedade não pode ser alterada com o objeto
ativo.
SelStart
Indica o ponto inicial do texto selecionado ou o ponto de inserção se nenhum texto é selecionado. Esta propriedade
não pode ser alterada com o objeto ativo.
SelText
Retorna o texto selecionado no objeto. Esta propriedade não pode ser alterada com o objeto ativo.
ShowDropButtonWhen
Esta propriedade especifica quando mostrar o botão suspenso, ou seja, a tecla de navegação do objeto. Os
valores possíveis para esta propriedade são 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 ou 2 - fmShowDropButtonWhenAlways: Sempre mostra o botão suspenso (padrão).
SpecialEffect
Esta propriedade 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 aparece plano e possui um destaque na borda,
uma alteração de cor ou ambos

1 - fmSpecialEffectRaised O objeto possui um destaque na parte superior

esquerda e uma sombra na parte inferior direita, como
se estivesse em relevo

2 - fmSpecialEffectSunken O objeto possui uma sombra na parte superior esquerda

e um destaque na parte inferior direita. O objeto e a
borda aparecem afundados na Tela (padrão)

3 - fmSpecialEffectEtched A borda parece estar esculpida ao redor da extremidade

do objeto

6 - fmSpecialEffectBump O objeto possui um ressalto na parte inferior direita e

parece plano na parte superior esquerda

Style
Determina o estilo do objeto. Os valores possíveis para esta propriedade são 0 - fmStyleDropDownCombo: A
Lista de Seleção se comporta como uma caixa de combinação suspensa, ou seja, o usuário pode digitar um valor na
região de edição ou selecionar um valor da lista suspensa (padrão) ou 2 - fmStyleDropDownList: A Lista de Seleção
se comporta como uma caixa de listagem e o usuário deve selecionar um valor da lista.
Text
Retorna o texto da opção selecionada. Esta propriedade é acessível apenas em tempo de execução.
TextAlign

162 Visualização
 Especifica como o texto é alinhado no objeto. Os valores possíveis para esta propriedade são 1 -
fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto (padrão), 2 - fmTextAlignCenter: Centraliza
o texto com o centro do objeto ou 3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto.
TextColumn
Esta propriedade identifica a coluna no objeto. Os valores para esta propriedade vão de -1 (menos um) ao número
de colunas na lista. O valor desta propriedade para a primeira coluna é 1 (um), o valor da segunda coluna é 2 (dois), e
assim por diante. Configurar esta propriedade com o valor 0 (zero) exibe os valores para a propriedade ListIndex.
Configurar esta propriedade com o valor -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 é somente de leitura.
TopIndex
Esta propriedade 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.
Value
Este é o valor da propriedade BoundColumn das linhas atualmente selecionadas. Uma mudança de valor nesta
propriedade não implica em mudança de valor na propriedade BoundColumn. Para adicionar ou apagar entradas em
uma lista de seleção, use os métodos AddItem ou RemoveItem.

[Link].13 Texto
Esta seção contém informações sobre propriedades do objeto Texto (LabelControl). Este objeto não possui eventos
nem métodos associados.

[Link].13.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Texto (LabelControl).
Accelerator
Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora é uma tecla que, usada em conjunto com a
tecla ALT, move o foco para o objeto. O valor padrão desta propriedade é uma String vazia.
AutoSize
Esta propriedade ajusta a largura do texto, caso a área disponível ultrapasse o tamanho do objeto. Para o objeto
Texto (Label), quando esta propriedade está configurada para Verdadeiro, o texto é redimensionado para coincidir
com o tamanho atual do objeto, permitindo assim a exibição completa.
BackStyle
Esta propriedade define o estilo do plano de fundo para os objetos. Os valores possíveis para esta propriedade
são 0 - fmBackStyleTransparent: Define o objeto como transparente, isto é, nenhum fundo deste objeto é
desenhado, ou 1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é desenhado (padrão).

NOTA
Esta propriedade não afeta a transparência de bitmaps. Deve-se usar um editor de imagens como o Paintbrush, por
exemplo, para tornar um bitmap transparente. Nem todos os objetos ActiveX suportam bitmaps transparentes.

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 edição. Para que esta propriedade seja aplicável, é necessário que a
propriedade BorderStyle esteja configurada com o valor 1 - fmBorderStyleSingle. O valor padrão desta propriedade
é preto (RGB(0, 0, 0)).
BorderStyle
Esta propriedade determina o estilo de borda que é aplicada ao objeto. Os valores possíveis para esta
propriedade são 0 - fmBorderStyleNone: Sem borda (padrão) ou 1 - fmBorderStyleSingle: Com borda simples.
Caption
Define o texto que é mostrado no objeto.

Visualização 163
Font
Esta propriedade é utilizada para determinar a fonte do objeto Texto. Esta propriedade não pode ser utilizada em
Associações e contém as subpropriedades descritas no tópico Fonte.
Picture
Esta propriedade especifica a figura (bitmap) atribuída ao objeto. Um arquivo com imagem pode ser selecionado
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 desta propriedade e pressione a tecla
DEL. A tecla BACKSPACE (tecla de espaço do teclado) não remove a figura.
PicturePosition
Esta propriedade especifica a posição da figura atribuída ao objeto em relação à 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 figura aparece à esquerda da legenda. A legenda é
alinhada com a parte superior da figura

1 - fmPicturePositionLeftCenter A figura aparece à esquerda da legenda. A legenda é

centralizada relativamente à imagem

2 - fmPicturePositionLeftBottom A figura aparece à esquerda da legenda. A legenda é

alinhada com a parte inferior da figura

3 - fmPicturePositionRightTop A figura aparece à direita da legenda. A legenda é

alinhada com a parte superior da figura

4 - fmPicturePositionRightCenter A figura aparece à direita da legenda. A legenda é

centralizada relativamente à figura

5 - fmPicturePositionRightBottom A figura aparece à direita da legenda. A legenda é

alinhada com a parte inferior da figura

6 - fmPicturePositionAboveLeft A figura aparece acima da legenda. A legenda é alinhada

com a extremidade esquerda da figura

7 - fmPicturePositionAboveCenter A figura aparece acima da legenda. A legenda é

centralizada abaixo da figura (padrão)

8 - fmPicturePositionAboveRight A figura aparece acima da legenda. A legenda é alinhada

com a extremidade direita da figura

9 - fmPicturePositionBelowLeft A figura aparece abaixo da legenda. A legenda é

alinhada com a extremidade esquerda da figura

10 - fmPicturePositionBelowCenter A figura aparece abaixo da legenda. A legenda é

centralizada acima da figura

11 - fmPicturePositionBelowRight A figura aparece abaixo da legenda. A legenda é

alinhada com a extremidade direita da figura

12 - fmPicturePositionCenter A figura aparece no centro do controle. A legenda é

centralizada horizontalmente e verticalmente sobre a
figura.

SpecialEffect
Esta propriedade 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 aparece plano e possui um destaque na borda,
uma alteração de cor ou ambos (padrão)

1 - fmSpecialEffectRaised O objeto possui um destaque na parte superior

esquerda e uma sombra na parte inferior direita. O
objeto parece estar em relevo

164 Visualização
 OPÇÃO DESCRIÇÃO
2 - fmSpecialEffectSunken O objeto possui uma sombra na parte superior esquerda
e um destaque na parte inferior direita. O objeto e a
borda parecem estar afundados na Tela

3 - fmSpecialEffectEtched A borda parece estar esculpida ao redor da extremidade

do objeto

6 - fmSpecialEffectBump O objeto possui um ressalto na parte inferior direita e

parece plano na parte superior esquerda

TextAlign
Especifica como o texto é alinhado neste objeto. Os valores possíveis para esta propriedade são 1 -
fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto (padrão), 2 - fmTextAlignCenter: Alinha o
texto com o centro do objeto ou 3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto.
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.

[Link] Polígono
Esta seção contém informações sobre propriedades do objeto Polígono (DrawLine). Este objeto não possui eventos
nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Polígono (DrawLine).

[Link].1.1 Points
Retorna o objeto Coleção de Pontos dentro do Polígono. O objeto Coleção de Pontos é utilizado para inserir,
remover ou acessar os Pontos disponíveis no Polígono. Esta propriedade é somente de leitura.

[Link].1.2 PolygonFill
Esta propriedade configura o modo de preenchimento da área do Polígono. Para determinar se a área deve ser
preenchida ou não, traça-se uma linha a partir de um ponto p em direção ao infinito sem passar por vértices. Os
valores possíveis para esta propriedade são os seguintes:
· 0 - Alternate: Se a linha traçada atravessa um número ímpar de linhas, a área do Polígono é preenchida. Caso
contrário, a área do Polígono não é preenchida
· 1 - Winding: Neste modo estabelece-se um contador para determinar se a área está dentro ou fora do Polígono.
Se a linha do Polígono corta a linha traçada no sentido horário, subtrai-se 1 (um) deste contador. Se a linha do
Polígono corta a linha traçada no sentido anti-horário, soma-se 1 (um) a este contador. Se ao final o contador é
igual a 0 (zero), a área não está dentro do Polígono e não é preenchida. Se o contador é diferente de 0 (zero), a
área está dentro do Polígono e é preenchida

[Link].2 Coleção de Pontos do Polígono

Esta seção contém informações sobre métodos e propriedades do objeto Coleção de Pontos do Polígono
(DrawLinePoints). Este objeto não possui eventos associados.

[Link].2.1 Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Pontos do Polígono (DrawLinePoints).
AddPoint
AddPoint(X, Y, [lIndexAt])
Adiciona um Ponto do Polígono na Coleção de Pontos do Polígono e retorna este objeto. O objeto é criado nas
coordenadas especificadas pelos parâmetros X e Y e no índice especificado pelo parâmetro lIndexAt. Se este
parâmetro é omitido ou é igual a -1 (menos um), o Ponto do Polígono é adicionado ao final da sequência de Pontos
do Polígono. Caso contrário, o valor deste parâmetro deve ser um número entre 1 (um) e o valor da propriedade
Count.

Visualização 165
DeletePoint
DeletePoint(lIndex)
Remove o Ponto do Polígono indicado pelo parâmetro lIndex, que é o índice do Ponto do Polígono na Coleção de
Pontos do Polígono. Só é possível remover Pontos do Polígono de uma Coleção de Pontos do Polígono com mais de
dois Pontos do Polígono.
Item
Item(Index)
Retorna um objeto Ponto do Polígono indicado pelo parâmetro Index, que é o índice do Ponto do Polígono na
Coleção de Pontos do Polígono.

[Link].2.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Pontos do Polígono (DrawLinePoints).
Count
Contém o número de Pontos do Polígono na Coleção. Esta propriedade é somente de leitura.

[Link].2.3 Ponto do Polígono

Esta seção contém informações sobre métodos e propriedades do objeto Ponto do Polígono (DrawLinePoint). Este
objeto não possui eventos associados.
Métodos
Esta seção contém informações sobre os métodos do objeto Ponto do Polígono (DrawLinePoint).
Delete
Delete()
Remove este Ponto do Polígono. Após utilizar este método, qualquer tentativa de acessar este objeto retorna um erro.
Propriedades
Esta seção contém informações sobre as propriedades do objeto Ponto do Polígono (DrawLinePoint).
X
Indica a coordenada horizontal deste Ponto do Polígono em relação à borda esquerda da Tela, em unidades
Himetric.
Y
Indica a coordenada vertical deste Ponto do Polígono em relação à borda superior da Tela, em unidades Himetric.

[Link] Polígono de Curvas

Esta seção contém informações sobre propriedades do objeto Polígono de Curvas (DrawBezier). Este objeto não
possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Polígono de Curvas (DrawBezier).

[Link].1.1 PolygonFill
Esta propriedade configura o modo de preenchimento da área do Polígono de Curvas. Para determinar se a área
deve ser preenchida ou não, traça-se uma linha a partir de um ponto p em direção ao infinito sem passar por vértices.
Os valores possíveis para esta propriedade são os seguintes:
· 0 - Alternate: Se a linha traçada atravessa um número ímpar de linhas, a área do Polígono de Curvas é
preenchida. Caso contrário, a área do Polígono de Curvas não é preenchida
· 1 - Winding: Neste modo estabelece-se um contador para determinar se a área está dentro ou fora do Polígono
de Curvas. Se a linha do Polígono de Curvas corta a linha traçada no sentido horário, subtrai-se 1 (um) deste
contador. Se a linha do Polígono de Curvas corta a linha traçada no sentido anti-horário, soma-se 1 (um) a este
contador. Se ao final o contador é igual a 0 (zero), a área não está dentro do Polígono de Curvas e não é
preenchida. Se o contador é diferente de 0 (zero), a área está dentro do Polígono de Curvas e é preenchida

166 Visualização
[Link] Retângulo Arredondado
Esta seção contém informações sobre propriedades do objeto Retângulo Arredondado (DrawTank). Este objeto não
possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Retângulo Arredondado (DrawTank).

[Link].1.1 RoundAspectX
Esta propriedade define o tamanho da dimensão das laterais do Retângulo no eixo X. Sendo assim, de acordo com
o valor definido na propriedade, os cantos do Retângulo mudam a forma, desde um retângulo até uma elipse. Esta
propriedade pode variar o valor de 0,1 até 1,0. O script a seguir contém um exemplo de uso desta propriedade.
Sub RetanguloArred_Click()
RoundAspectX = 0.5
End Sub

[Link].1.2 RoundAspectY
Esta propriedade define o tamanho da dimensão da altura do Retângulo no eixo Y. Sendo assim, de acordo com o
valor definido na propriedade, os cantos do Retângulo mudam a forma, desde um retângulo até uma elipse. Esta
propriedade pode variar o valor de 0,1 até 1,0. O script a seguir contém um exemplo de uso desta propriedade.
Sub RetanguloArred_Click()
RoundAspectY = 0.5
End Sub

[Link] Texto, Display e SetPoint

Esta seção contém informações sobre eventos e propriedades dos objetos Texto, Display e SetPoint (DrawString).
Este objeto não possui métodos associados.

[Link].1 Eventos
Esta seção contém informações sobre os eventos dos objetos Texto, Display e SetPoint (DrawString).

[Link].1.1 Validate
Validate(Cancel, NewValue)
Ocorre após os testes de limites do SetPoint (consulte as 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 é 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. O script a
seguir contém um exemplo de uso deste evento.
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

[Link].2 Propriedades
Esta seção contém informações sobre as propriedades dos objetos Texto, Display e SetPoint (DrawString).

[Link].2.1 EnableLimits
Indica se é executada a verificação de limites no texto. Quando esta propriedade é igual a Verdadeiro, e o usuário
inserir um valor não numérico ou inserir um valor fora dos limites definidos em MinLimit e MaxLimit, uma mensagem
de erro é mostrada (a propriedade IsSetPoint deve ser igual a Verdadeiro). O script a seguir contém um exemplo de
uso desta propriedade.

Visualização 167
 Sub CommandButton1_Click()
[Link]("Texto1").EnableLimits = _
Not([Link]("Texto1").EnableLimits)
End Sub

[Link].2.2 Format
Esta propriedade 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 destes dados. Esta propriedade pode ser editada manualmente
ou configurada através da janela de formatação. O uso é semelhante aos formatadores usados nas planilhas de
dados, seguindo a mesma sintaxe. A tabela a seguir contém os tipos de dados suportados.
Tipos de dados suportados pela propriedade Format
TIPO DE DADOS DESCRIÇÃO
Numérico Saída decimal, científica, hexadecimal, binária ou octal

Texto Textos em geral

Booleano Valores Booleanos

Data e Hora Calendário Gregoriano

[Link].2.3 IsSetPoint
Esta propriedade é utilizada para determinar se um objeto tem comportamento de SetPoint, ou seja, se permite a
edição da propriedade Value. A propriedade Value consiste em um Variant, que pode assumir valores de todo e
qualquer tipo. Esta propriedade é Booleana e assume o seguinte comportamento: se esta propriedade é igual a
Verdadeiro, permite a edição e, se esta propriedade é igual a Falso, não permite a edição. Este comportamento pode
ser visualizado quando o Elipse E3 Viewer está em execução. O valor padrão desta propriedade é Verdadeiro.

NOTA
Configurar esta propriedade para Falso em tempo de execução cancela a edição corrente e descarta o conteúdo
deste objeto.

[Link].2.4 KeepFormatWhenEditing
Permite que o valor do objeto seja editado com ou sem formatação. Os valores possíveis para esta propriedade
são 0 - kfNever: O valor é sempre editado sem formatação (padrão) ou 1 - kfAutomatic: Permite que o valor seja
editado no valor formatado, caso o Elipse E3 detecte que o texto formatado é passível de ser interpretado como um
valor. Caso o formato seja considerado incompatível, o valor é editado sem formatação.

[Link].2.5 MaxCharacters
Esta propriedade estabelece um limite de caracteres que o usuário pode digitar, quando em modo de edição, em
um objeto Texto, Display ou SetPoint. As seguintes restrições se aplicam a esta propriedade:
· Configurar esta propriedade em 0 (zero) não limita o número de caracteres na edição destes controles, e também
configura a propriedade RemainingCharacters em 0 (zero)
· Ao colar um texto que tenha mais caracteres que o valor configurado nesta propriedade, este texto é cortado
· Ao modificar o valor desta propriedade para um valor menor que o tamanho do texto já contido no controle,
este texto é cortado
· O valor desta propriedade vale para o número de caracteres que o usuário pode digitar, sem levar em conta a
formatação do controle

[Link].2.6 MaxLimit
Contém o valor máximo permitido no objeto (a propriedade EnableLimits deve ser igual a Verdadeiro). O script a
seguir contém um exemplo de uso desta propriedade.
Sub CommandButton3_Click()
[Link]("Texto1").MaxLimit = [Link]("Texto6").Value
End Sub

[Link].2.7 MinLimit
Contém o valor mínimo permitido no objeto (a propriedade EnableLimits deve ser igual a Verdadeiro). O script a
seguir contém um exemplo de uso desta propriedade.

168 Visualização
 Sub CommandButton2_Click()
[Link]("Texto1").MinLimit = [Link]("Texto5").Value
End Sub

[Link].2.8 Multiline
Esta propriedade indica se o texto tem múltiplas linhas (Verdadeiro) ou se é uma caixa de texto simples (Falso). Este
comportamento pode ser visualizado quando o Elipse E3 Viewer está em execução. O valor padrão desta
propriedade é Falso.

[Link].2.9 RemainingCharacters
Esta propriedade indica o número de caracteres que o usuário ainda pode digitar em um objeto Texto, Display ou
SetPoint, caso a propriedade MaxCharacters seja configurada para um valor maior que 0 (zero). Esta propriedade é
somente de leitura e só está disponível em tempo de execução.

[Link].2.10 SetPointDataType
Determina o tipo de valor que é enviado do SetPoint para o Tag. Os valores possíveis para esta propriedade estão
descritos na tabela a seguir.
Opções disponíveis para a propriedade SetPointDataType
OPÇÃO DESCRIÇÃO
0 - stCurrentType Mantém o tipo do valor atual no SetPoint (padrão, ver a
seguir)

1 - stChar Valor inteiro de 8 bits com sinal

2 - stByte Valor inteiro de 8 bits sem sinal

3 - stWord Valor inteiro de 16 bits sem sinal

4 - stInteger Valor inteiro de 16 bits com sinal

5 - stLong Valor inteiro de 32 bits com sinal

6 - stDWord Valor inteiro de 16 bits sem sinal

7 - stSingle Valor de ponto flutuante de 32 bits

8 - stDouble Valor de ponto flutuante de 64 bits

9 - stDateTime Valor de data e hora

10 - stString Texto

Quando o texto digitado é enviado pelo SetPoint, este primeiro tenta converter o valor para o tipo de dados
configurado (Word, String ou Double, entre outros). Se a conversão não é possível, ou seja, o valor digitado é
inválido para o tipo de dados selecionado, nenhum valor é enviado, como por exemplo se o usuário digita -1 (menos
um) e o tipo de dados é Byte. Já quando o valor da propriedade é igual a 0 - stCurrentType, o tipo de dados
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. O script a seguir contém um exemplo de uso
desta propriedade.
Sub Combobox1_Change()
[Link]("Texto1").SetPointDataType = CInt(Left(Value, 2))
End Sub

[Link].2.11 StretchText
Redimensiona o tamanho do objeto. A partir do momento em que esta propriedade é habilitada, o objeto
automaticamente redimensiona o tamanho da fonte do texto para que a área ocupada continue sempre a mesma. De
outra forma, se esta propriedade está configurada para Falso, nenhum redimensionamento é efetuado.

[Link].2.12 TextAlignment
Esta propriedade especifica o alinhamento horizontal do texto mostrado no objeto. Os valores possíveis para esta
propriedade estão descritos na tabela a seguir.

Visualização 169
 Opções disponíveis para a propriedade TextAlignment
OPÇÃO DESCRIÇÃO
0 - LeftAlignment O alinhamento horizontal do texto é à esquerda

1 - CenterAlignment O alinhamento horizontal do texto é centralizado

(padrão)

2 - RightAlignment O alinhamento horizontal do texto é à direita

[Link].2.13 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)).

[Link].2.14 TextFont
Define as informações da fonte a ser utilizado pelo objeto de Tela. Esta propriedade não pode ser utilizada em
Associações e as sub-propriedades podem ser consultadas no tópico Fonte.

[Link].2.15 Value
Esta propriedade consiste em um Variant que pode assumir valores de todo e qualquer tipo de dados, e que é
exibido pelo objeto. Geralmente esta propriedade contém um texto, pois é automaticamente preenchida quando
ocorre a criação de um novo objeto Texto. A propriedade IsSetPoint é utilizada para determinar se o objeto Texto
tem o mesmo comportamento de um SetPoint, ou seja, permite a edição desta propriedade. O script a seguir contém
um exemplo de uso desta propriedade.
Sub DrawString1_OnStartRunning()
' Lê o valor de um tag e mostra o Texto
Dim obj
Set obj = [Link]("DataServer1.DemoTag1")
Value = "Valor de DemoTag1 = " & [Link]
End Sub

[Link].2.16 VertTextAlignment
Determina o alinhamento vertical do texto do objeto. Os valores possíveis para esta propriedade estão descritos
na tabela a seguir.
Opções disponíveis para a propriedade VertTextAlignment
OPÇÃO DESCRIÇÃO
0 - TopAlignment Alinhamento vertical do texto no topo do objeto

1 - MidAlignment Alinhamento vertical do texto no centro do objeto

(padrão)

2 - BottomAlignment Alinhamento vertical do texto na base do objeto

[Link].2.17 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.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.

170 Visualização
[Link] KeyPress
KeyPress(KeyAscii)
Ocorre quando o E3Alarm tem o foco de teclado e o usuário pressiona uma tecla correspondente a um caractere que
pode ser mostrado em tela, ou seja, uma tecla ANSI de código indicado no parâmetro KeyAscii. Este 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

Este evento não ocorre nas seguintes condições:

· Pressionando-se a tecla TAB
· Pressionando-se a tecla ENTER
· Pressionando-se a tecla DEL, que não é padrão ANSI
· Pressionando-se as setas do teclado
· Quando uma tecla move o foco de um objeto a outro

Enquanto o usuário pressiona uma tecla que produz um código ANSI, o E3Alarm recebe este evento e o evento
KeyDown repetidamente. Quando o usuário libera esta tecla, o evento KeyUp ocorre. Para monitorar o estado físico
do teclado ou manipular teclas não reconhecidas por este evento, como por exemplo teclas de função ou de
navegação, utilize os eventos KeyDown e KeyUp.

NOTA
Para uma lista com todos os códigos de tecla disponíveis para o parâmetro KeyAscii, consulte o artigo Keys Enum no
Microsoft Learn.

[Link] 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.

[Link] AboutBox
AboutBox()
Este método exibe uma caixa de diálogo com informações sobre versão e copyright do objeto E3Alarm.

[Link] AckAll
AckAll([Operator])
Permite reconhecer globalmente todos os Alarmes. O parâmetro Operator é uma String opcional que indica o nome
do operador que reconheceu o Alarme. Este valor é mostrado na coluna Operator do E3Alarm. Se omitido, é utilizado
o usuário atual do Elipse E3 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.

[Link] AckCurrentFilter
AckCurrentFilter([Operator])
Permite reconhecer todos os Alarmes do filtro corrente. O parâmetro Operator é uma String opcional que indica o
nome do operador que reconheceu o Alarme. Este valor é mostrado na coluna Operator do E3Alarm. Se omitido, é
utilizado o usuário atual do Elipse E3 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.

Visualização 171
[Link] AckSelected
AckSelected([Operator])
Permite reconhecer os Alarmes selecionados. Se não há Alarme selecionado no E3Alarm, este método falha. O usuário
pode reconhecer o Alarme, e neste caso é inserido um novo registro no Banco de Dados indicando o reconhecimento,
e no E3Alarm a linha correspondente indica que foi reconhecido. O parâmetro Operator é uma String opcional que
indica o nome do operador que reconheceu o Alarme. Este valor é mostrado na coluna Operator do E3Alarm. Se
omitido, é utilizado o usuário atual do Elipse E3 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.

[Link] DeleteUnboundAll
DeleteUnboundAll([Operator])
Permite remover globalmente todos os Alarmes não vinculados. O parâmetro Operator é uma String opcional que
indica o nome do operador que removeu o Alarme. Este valor é mostrado na coluna Operator do E3Alarm. Se
omitido, é utilizado o usuário atual do Elipse E3 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.

[Link] DeleteUnboundCurrentFilter
DeleteUnboundCurrentFilter([Operator])
Permite remover todos os Alarmes não vinculados do filtro corrente. O parâmetro Operator é uma String opcional
que indica o nome do operador que removeu o Alarme. Este valor é mostrado na coluna Operator do E3Alarm. Se
omitido, é utilizado o usuário atual do Elipse E3 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.

[Link] DeleteUnboundSelected
DeleteUnboundSelected([Operator])
Permite remover os Alarmes não vinculados selecionados. Se não há Alarme não vinculado selecionado no E3Alarm,
este método falha. O usuário pode remover o Alarme, e neste caso é inserido um novo registro no Banco de Dados
indicando a remoção, e no E3Alarm a linha correspondente indica que foi removido. O parâmetro Operator é uma
String opcional que indica o nome do operador que reconheceu o Alarme. Este valor é mostrado na coluna Operator
do E3Alarm. Se omitido, é utilizado o usuário atual do Elipse E3 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.

[Link] 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.

[Link] GetFocusedEvent
GetFocusedEvent()
Este método retorna um objeto com as propriedades do Evento selecionado, ou seja, aquele que tem o foco atual, no
E3Alarm, caso haja algum Evento selecionado. Se nenhum Evento está selecionado, este método retorna um objeto
Nothing.
As propriedades do objeto retornado contém os valores dos Campos do Evento selecionado. Este 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.

[Link] RemoveFromServiceAll
RemoveFromServiceAll(Reason, [Operator])
Permite suprimir todos os Alarmes usando o tipo Fora de Serviço (Out-of-Service). O parâmetro Reason indica o
motivo para a supressão. O parâmetro Operator é uma String opcional que indica o nome do operador que suprimiu

172 Visualização
o Alarme ou Evento de serviço. Este valor é mostrado na coluna Operator do E3Alarm. Se omitido, é utilizado o
usuário atual do Elipse E3 Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado. Para a supressão em si é
necessário que o usuário logado tenha a permissão Remover alarmes de serviço.

[Link] RemoveFromServiceCurrentFilter
RemoveFromServiceCurrentFilter(Reason, [Operator])
Permite suprimir todos os Alarmes do filtro corrente usando o tipo Fora de Serviço (Out-of-Service). O parâmetro
Reason indica o motivo para a supressão. O parâmetro Operator é uma String opcional que indica o nome do
operador que suprimiu o Alarme ou Evento de serviço. Este valor é mostrado na coluna Operator do E3Alarm. Se
omitido, é utilizado o usuário atual do Elipse E3 Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado.
Para a supressão em si é necessário que o usuário logado tenha a permissão Remover alarmes de serviço.

[Link] RemoveFromServiceSelected
RemoveFromServiceSelected(Reason, [Operator])
Permite suprimir todos os Alarmes selecionados usando o tipo Fora de Serviço (Out-of-Service). O parâmetro Reason
indica o motivo para a supressão. O parâmetro Operator é uma String opcional que indica o nome do operador que
suprimiu o Alarme ou Evento de serviço. Este valor é mostrado na coluna Operator do E3Alarm. Se omitido, é utilizado
o usuário atual do Elipse E3 Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado. Para a supressão em
si é necessário que o usuário logado tenha a permissão Remover alarmes de serviço.

[Link] ReturnToServiceAll
ReturnToServiceAll([Operator])
Permite voltar a operar normalmente todos os Alarmes suprimidos do tipo Fora de Serviço (Out-of-Service). O
parâmetro Operator é uma String opcional que indica o nome do operador que retornou de serviço o Alarme ou
Evento suprimido. Este valor é mostrado na coluna Operator do E3Alarm. Se omitido, é utilizado o usuário atual do
Elipse E3 Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado. Para o retorno em si é necessário que o
usuário logado tenha a permissão Retornar alarmes ao serviço.

[Link] ReturnToServiceCurrentFilter
ReturnToServiceCurrentFilter([Operator])
Permite voltar a operar normalmente todos os Alarmes suprimidos do tipo Fora de Serviço (Out-of-Service) do filtro
corrente. O parâmetro Operator é uma String opcional que indica o nome do operador que retornou de serviço o
Alarme ou Evento suprimido. Este valor é mostrado na coluna Operator do E3Alarm. Se omitido, é utilizado o usuário
atual do Elipse E3 Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado. Para o retorno em si é
necessário que o usuário logado tenha a permissão Retornar alarmes ao serviço.

[Link] ReturnToServiceSelected
ReturnToServiceSelected([Operator])
Permite voltar a operar normalmente todos os Alarmes suprimidos do tipo Fora de Serviço (Out-of-Service)
selecionados. O parâmetro Operator é uma String opcional que indica o nome do operador que retornou de serviço
o Alarme ou Evento suprimido. Este valor é mostrado na coluna Operator do E3Alarm. Se omitido, é utilizado o
usuário atual do Elipse E3 Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado. Para o retorno em si é
necessário que o usuário logado tenha a permissão Retornar alarmes ao serviço.

[Link] ShelveAll
ShelveAll(Duration, Reason, [Operator])
Permite arquivar globalmente todos os Alarmes e Eventos. O parâmetro Duration indica o período de tempo, em
minutos, que os Alarmes ou Eventos permanecem arquivados. O parâmetro Reason indica o motivo para o
arquivamento. O parâmetro Operator é uma String opcional que indica o nome do operador que arquivou o Alarme
ou Evento. Este valor é mostrado na coluna Operator do E3Alarm. Se omitido, é utilizado o usuário atual do Elipse E3
Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado. Para o arquivamento em si é necessário que o
usuário logado tenha a permissão Arquivar alarmes.

Visualização 173
[Link] ShelveCurrentFilter
ShelveCurrentFilter(Duration, Reason, [Operator])
Permite arquivar todos os Alarmes ou Eventos do filtro corrente. O parâmetro Duration indica o período de tempo,
em minutos, que os Alarmes ou Eventos permanecem arquivados. O parâmetro Reason indica o motivo para o
arquivamento. O parâmetro Operator é uma String opcional que indica o nome do operador que arquivou o Alarme
ou Evento. Este valor é mostrado na coluna Operator do E3Alarm. Se omitido, é utilizado o usuário atual do Elipse E3
Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado. Para o arquivamento em si é necessário que o
usuário logado tenha a permissão Arquivar alarmes.

[Link] ShelveSelected
ShelveSelected(Duration, Reason, [Operator])
Permite arquivar os Alarmes ou Eventos selecionados. Se não há Alarme ou Evento selecionado no E3Alarm, este
método falha. O usuário pode arquivar um Alarme ou Evento, e neste caso é inserido um novo registro no Banco de
Dados indicando o arquivamento, e no E3Alarm a linha correspondente indica que foi arquivado. O parâmetro
Duration indica o período de tempo, em minutos, que os Alarmes ou Eventos permanecem arquivados. O parâmetro
Reason indica o motivo para o arquivamento. O parâmetro Operator é uma String opcional que indica o nome do
operador que arquivou o Alarme ou Evento. Este valor é mostrado na coluna Operator do E3Alarm. Se omitido, é
utilizado o usuário atual do Elipse E3 Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado. Para o
arquivamento em si é necessário que o usuário logado tenha a permissão Arquivar alarmes.

[Link] UnshelveAll
UnshelveAll(Reason, [Operator])
Permite desarquivar globalmente todos os Alarmes ou Eventos arquivados. O parâmetro Reason indica o motivo para
o desarquivamento. O parâmetro Operator é uma String opcional que indica o nome do operador que desarquivou o
Alarme ou Evento. Este valor é mostrado na coluna Operator do E3Alarm. Se omitido, é utilizado o usuário atual do
Elipse E3 Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado. Para o desarquivamento em si é
necessário que o usuário logado tenha a permissão Desarquivar alarmes.

[Link] UnshelveCurrentFilter
UnshelveCurrentFilter(Reason, [Operator])
Permite desarquivar todos os Alarmes ou Eventos do filtro corrente. O parâmetro Reason indica o motivo para o
desarquivamento. O parâmetro Operator é uma String opcional que indica o nome do operador que desarquivou o
Alarme ou Evento. Este valor é mostrado na coluna Operator do E3Alarm. Se omitido, é utilizado o usuário atual do
Elipse E3 Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado. Para o desarquivamento em si é
necessário que o usuário logado tenha a permissão Desarquivar alarmes.

[Link] UnshelveSelected
UnshelveSelected(Reason, [Operator])
Permite desarquivar os Alarmes ou Eventos selecionados. Se não há Alarmes ou Eventos selecionados no E3Alarm,
este método falha. O usuário pode desarquivar um Alarme ou Evento, e neste caso é inserido um novo registro no
Banco de Dados indicando o desarquivamento, e no E3Alarm a linha correspondente indica que foi desarquivado. O
parâmetro Reason indica o motivo para o desarquivamento. O parâmetro Operator é uma String opcional que indica o
nome do operador que desarquivou o Alarme ou Evento. Este valor é mostrado na coluna Operator do E3Alarm. Se
omitido, é utilizado o usuário atual do Elipse E3 Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado.
Para o desarquivamento em si é necessário que o usuário logado tenha a permissão Desarquivar alarmes.

4.4.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto E3Alarm.

NOTA
O Elipse E3 utiliza, para definição de coordenadas e espessura, o sistema Himetric. Neste sistema, cada unidade
lógica equivale a um milésimo de centímetro, ou seja, cada 1000 unidades equivalem a um centímetro. Assim, este é
o padrão adotado na descrição das propriedades do Elipse E3, quando aplicável.

174 Visualização
[Link] ActiveAlarms
Determina o número total de Alarmes ativos em um E3Alarm. Esta propriedade é somente de leitura.

[Link] ActiveCritAlarms
Indica o número de Alarmes ativos com severidade Crítica em um E3Alarm. Esta propriedade é somente de leitura.

[Link] ActiveCritNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Crítica em um E3Alarm. Esta propriedade é somente
de leitura.

[Link] ActiveHighAlarms
Indica o número de Alarmes ativos com severidade Alta em um E3Alarm. Esta propriedade é somente de leitura.

[Link] ActiveHighNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Alta em um E3Alarm. Esta propriedade é somente
de leitura.

[Link] ActiveLowAlarms
Indica o número de Alarmes ativos com severidade Baixa em um E3Alarm. Esta propriedade é somente de leitura.

[Link] ActiveLowNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Baixa em um E3Alarm. Esta propriedade é somente
de leitura.

[Link] ActiveMedAlarms
Indica o número de Alarmes ativos com severidade Média em um E3Alarm. Esta propriedade é somente de leitura.

[Link] ActiveMedNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Média em um E3Alarm. Esta propriedade é somente
de leitura.

[Link] ActiveNACKAlarms
Indica o número total de Alarmes que estão sem reconhecimento em um E3Alarm, ativos ou não. Esta propriedade é
somente de leitura.

[Link] AlarmCount
Determina o número de Alarmes em um E3Alarm. Esta propriedade é somente de leitura.

[Link] AlarmServer
Nome do Servidor de Alarmes único existente em uma aplicação.

[Link] AllowAckAll
Habilita ou desabilita a opção Reconhecimento no menu contextual de um E3Alarm, que permite o reconhecimento
de todos os Alarmes. O valor padrão desta propriedade é Verdadeiro.

[Link] AllowAckCurrentFilter
Habilita ou desabilita o item Todos os alarmes do filtro corrente da opção Reconhecimento no menu contextual
de um E3Alarm, que permite o reconhecimento de todos os Alarmes do filtro atual. Se não há Alarmes visíveis, esta
propriedade não tem efeito. O valor padrão desta propriedade é Verdadeiro.

[Link] AllowAckSelected
Habilita ou desabilita o item Apenas os alarmes selecionados da opção Reconhecimento no menu contextual de
um E3Alarm, que permite o reconhecimento de Alarmes selecionados. Se não há Alarmes selecionados, esta

Visualização 175
propriedade não tem efeito. O valor padrão desta propriedade é Verdadeiro.

[Link] 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 de um E3Alarm em tempo de execução. Se esta opção está configurada para Verdadeiro e o cabeçalho está
visível, ao clicar no título da coluna os dados são ordenados, tendo esta coluna como chave. Para mais informações,
consulte a propriedade ColumnHeader. Clicando novamente nesta mesma coluna, a ordenação é realizada na direção
contrária, ou seja, 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.

[Link] AllowDeleteUnboundAlarms
Habilita ou desabilita a opção Deletar alarmes desvinculados no menu contextual de um E3Alarm, que permite
remover Alarmes não vinculados. Se não há Alarmes não vinculados, esta propriedade não tem efeito. O valor padrão
desta propriedade é Verdadeiro.

[Link] AllowRemoveFromServiceAlarms
Configura se um E3Alarm permite ou não a supressão de Alarmes do tipo Fora de Serviço (Out-of-Service). O valor
padrão desta propriedade é Verdadeiro.

[Link] AllowShelveAlarms
Habilita ou desabilita as opções Arquivar Alarmes e Desarquivar Alarmes no menu contextual de um E3Alarm, que
permitem o arquivamento ou desarquivamento de todos os Alarmes ou Eventos. O valor padrão desta propriedade é
Verdadeiro.

[Link] AreaFilter
Controla as Áreas de Alarme visíveis em um E3Alarm. Se o valor não é uma String vazia, são apresentados Eventos
cujo nome das Áreas comecem com o texto indicado. Por exemplo, se esta propriedade é igual a "Ana", são
mostrados os alarmes de Áreas como "[Link]" ou "Analise", mas não "[Link]" ou
"[Link]". Quando a propriedade SimpleAreaFilter está configurada como Falso, a Área de Alarme também
permite o uso de caracteres curingas para a filtragem e múltiplos filtros de Área, separados por dois pontos. Consulte
a propriedade AreaFilter do objeto Filtro de Alarme para informações sobre os caracteres curinga permitidos. O
valor padrão desta propriedade é uma String vazia, ou seja, sem filtragem por Área. Consulte também as
propriedades CustomFilter, SimpleAreaFilter, ShowCriticalPriority, ShowHighPriority, ShowMediumPriority e
ShowLowPriority.

NOTA
Esta propriedade corresponde à propriedade Filter, disponível até a versão 4.0 do Elipse E3.

[Link] BannerMode
Habilita a visualização de apenas uma mensagem em um 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 E3.

[Link] BorderColor
Define a cor da borda de um E3Alarm. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).

[Link] BorderThickness
Define a espessura da borda de um E3Alarm. O valor desta propriedade pode variar entre 0 (zero, que desabilita a
borda) e 10, e o valor padrão é 1 (um).

[Link] ColorAckedAlarm
Define um objeto que configura as cores de um Alarme reconhecido. Esta propriedade é indexada pela severidade
do Alarme e só está disponível via script. Para mais informações sobre o comportamento desta propriedade, consulte
a propriedade ColorActiveAlarm.

176 Visualização
[Link] ColorActiveAlarm
Define um objeto que configura as cores de um Alarme ativo. Esta propriedade é indexada pela severidade do
Alarme e só está disponível via script. A tabela a seguir contém os valores possíveis para o índice desta propriedade.
Opções disponíveis para o índice da propriedade ColorActiveAlarm
ÍNDICE SEVERIDADE OBJETO RETORNADO
-2 Crítica Define as cores para Alarmes ativos
com severidade crítica

-1 - Define as cores para Alarmes ativos,

independente da severidade

0 Alta Define as cores para Alarmes ativos

com severidade alta

1 Média Define as cores para Alarmes ativos

com severidade média

2 Baixa Define as cores para Alarmes ativos

com severidade baixa

O código a seguir contém um exemplo de uso desta propriedade.

' Retorna um objeto para configurar as cores dos Alarmes ativos com severidade alta
Set Objeto = [Link]("E3Alarm1").ColorActiveAlarm(0)
' Copia as configurações de Alarme ativo com severidade alta (0)
' para o Alarme ativo com severidade média (1)
[Link]("E3Alarm1").ColorActiveAlarm(1) = [Link]("E3Alarm1").ColorActiveAlarm(0)

O objeto retornado por esta propriedade representa um Alarme ativo em uma severidade específica, ou seja, crítica,
alta, média, baixa ou a configuração padrão deste tipo de Alarme. A partir deste objeto é possível configurar a cor de
fundo, a cor de texto e o modo de pisca do Alarme, que também estão disponíveis para configuração através da
Janela de Propriedades do objeto E3Alarm, na aba Cores. Para mais informações sobre o objeto retornado por esta
propriedade, consulte o tópico Cor do Alarme.

[Link] ColorActiveEvent
Define um objeto que configura as cores de um Evento ativo. Esta propriedade é indexada pela severidade do
Alarme e só está disponível via script. Para mais informações sobre o comportamento desta propriedade, consulte a
propriedade ColorActiveAlarm.

[Link] ColorNAckAlarm
Define um objeto que configura as cores de um Alarme não reconhecido. Esta propriedade é indexada pela
severidade do Alarme e só está disponível via script. Para mais informações sobre o comportamento desta
propriedade, consulte a propriedade ColorActiveAlarm.

[Link] ColumnHeader
Esta propriedade habilita ou não a visualização do cabeçalho de um E3Alarm. O cabeçalho também permite que
seja realizada a reordenação dos dados da tabela visualmente. Para mais informações, consulte a propriedade
AllowColumnClick. O valor padrão desta propriedade é Verdadeiro.

[Link] Connections
Retorna uma coleção de Conexões em um E3Alarm. Esta propriedade é somente de leitura. Para mais informações
sobre a coleção retornada nesta propriedade, consulte o tópico Coleção de Conexões.

[Link] ConnectionStatusBarColor
Especifica a cor da barra de status de conexões de um E3Alarm. O valor padrão desta propriedade é preto (RGB(0,
0, 0)).

Visualização 177
[Link] CustomFilter
Permite informar um Filtro personalizado para Alarmes, na forma de uma expressão. Consulte a propriedade
CustomFilter do objeto Filtro de Alarmes para informações sobre os Campos disponíveis para utilização na
expressão deste Filtro. Os Campos definidos pelo usuário também podem ser utilizados na expressão de um Filtro,
utilizando-se o nome definido no Servidor de Alarmes.
Ao todo, as mensagens que aparecem na listagem do E3Alarm sempre passam pelos seguintes Filtros:
· Filtro por tipo, definido na propriedade FilterType
· Filtro por severidade, definida nas propriedades ShowCriticalProperty, ShowLowPriority, ShowMediumPriority
e ShowHighPriority
· Filtro por Área, definida nas propriedades AreaFilter e SimpleAreaFilter
· Filtro por esta propriedade
· Filtro do Sumário de Alarmes, equivalente à expressão "Enabled AND (ConditionActive OR (AckRequired AND NOT
Acked))"

Exemplos de Utilização da Propriedade CustomFilter

Para um Campo de Usuário chamado IsSupressed, e que se queira mostrar apenas Alarmes em que este Campo tem
valor diferente de 0 (zero), a expressão a ser utilizada é a seguinte:
IsSupressed <> 0

Para mostrar apenas mensagens com a Subcondição "HIHI" ou "LOLO" de objetos de Alarme cujo nome inicie por
"Pressure", a expressão a ser utilizada é a seguinte:
(SubConditionName = "HIHI" OR SubConditionName = "LOLO")
AND (Mid(AlarmSourceName, 1, 8) = "Pressure")

[Link] Domain
Especifica o Domínio ao qual um E3Alarm se conecta, como por exemplo "\\NomedeOutroServidor". O valor padrão
desta propriedade é uma String vazia, ou seja, o E3Alarm se conecta ao mesmo Domínio do Elipse E3 Viewer onde
se encontra.

[Link] EnableSortMarker
Habilita ou desabilita uma indicação de ordenação de uma coluna de um E3Alarm. Somente a primeira coluna
utilizada na ordenação mostra esta indicação. Para aplicações criadas na versão 4.8 ou mais recentes, o valor padrão
desta propriedade é Verdadeiro. Para aplicações criadas em versões anteriores e atualizadas para a versão 4.8 ou
superiores, o valor padrão desta propriedade é Falso.

Indicação de ordenação pela coluna Mensagem em ordem descendente

[Link] Events
Retorna uma coleção de Eventos em um E3Alarm. Esta propriedade é somente de leitura. Para mais informações
sobre a coleção retornada nesta propriedade, consulte o tópico Coleção de Eventos.

[Link] Fields
Retorna uma coleção de Campos em um E3Alarm. Esta propriedade é somente de leitura. Para mais informações
sobre a coleção retornada nesta propriedade, consulte o tópico Coleção de Campos.

178 Visualização
[Link] Filters
Retorna uma coleção de Filtros em um E3Alarm. Esta propriedade é somente de leitura. Para mais informações
sobre a coleção retornada nesta propriedade, consulte o tópico Coleção de Filtros.

[Link] FilterType
Efetua os Filtros de Alarme. Os valores possíveis para esta propriedade são 1 - OnlyAlarms: Mostra apenas
Alarmes (padrão), 2 - OnlyEvents: Mostra apenas Eventos ou 3 - AlarmsAndEvents: Mostra tanto Alarmes quanto
Eventos.

[Link] Font
Determina a fonte, ou tipo de letra, do cabeçalho e das linhas de um E3Alarm. Esta propriedade é somente de
leitura e só pode ser modificada via Elipse E3 Studio, não em tempo de execução. Consulte o tópico Fonte para mais
informações sobre as sub-propriedades desta propriedade.

[Link] FourthSortAscending
Quando esta propriedade está 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.

[Link] FourthSortField
Determina o Campo quaternário para a ordenação dos Eventos em um E3Alarm. O nome do Campo deve ser
sempre especificado em inglês. Consulte os Campos disponíveis no Manual do Usuário do Elipse E3. O valor padrão
desta propriedade é uma String vazia. Esta propriedade não tem efeito quando as propriedades PrimarySortField,
SecondarySortField ou ThirdSortField são configuradas como uma String vazia.

[Link] GridBkColor
Esta propriedade determina a cor de fundo de um E3Alarm. O valor padrão desta propriedade é a cor configurada
no Windows para o item Janela, em Painel de Controle - Vídeo - Aparência - Avançada.

[Link] InactiveCritNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Crítica em um E3Alarm. Esta propriedade
é somente de leitura.

[Link] InactiveHighNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Alta em um E3Alarm. Esta propriedade é
somente de leitura.

[Link] InactiveLowNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Baixa em um E3Alarm. Esta propriedade é
somente de leitura.

[Link] InactiveMedNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Média em um E3Alarm. Esta propriedade é
somente de leitura.

[Link] InactiveNACKAlarms
Determina o número total de Alarmes inativos e não reconhecidos em um E3Alarm. Esta propriedade é somente de
leitura.

[Link] PictureConnected
Caminho de um arquivo de imagem com o ícone para representar uma Conexão da Coleção de Conexões de um
E3Alarm conectada com sucesso a um Servidor de Alarmes. O valor padrão desta propriedade é uma String vazia, ou
seja, o E3Alarm apresenta o ícone na barra de status para esta Conexão.

Visualização 179
[Link] PictureNotConnected
Caminho de um arquivo de imagem com o ícone para representar uma Conexão da Coleção de Conexões de um
E3Alarm não conectada a um Servidor de Alarmes. O valor padrão desta propriedade é uma String vazia, ou seja, o
E3Alarm apresenta o ícone na barra de status para esta Conexão.

[Link] PictureUnknown
Caminho de um arquivo de imagem com o ícone para representar uma Conexão da Coleção de Conexões de um
E3Alarm com o status indefinido. O valor padrão desta propriedade é uma String vazia, ou seja, o E3Alarm apresenta
o ícone na barra de status para esta Conexão.

NOTA
O status indefinido indica que um E3Alarm não recebeu uma confirmação do Servidor de Alarmes de que a conexão
teve sucesso. Este é o status padrão para versões anteriores à 4.7.

[Link] PopupMenu
Habilita um menu contextual ao clicar com o botão direito do mouse em um E3Alarm. O valor padrão desta
propriedade é Verdadeiro.

[Link] PrimarySortAscending
Quando esta propriedade está 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.

[Link] PrimarySortField
Determina o Campo primário para a ordenação dos Eventos em um E3Alarm. O nome do Campo deve ser sempre
especificado em inglês. Consulte os Campos disponíveis no Manual do Usuário do Elipse E3. O valor padrão desta
propriedade é "EventTime". Quando esta propriedade é uma String vazia, as propriedades SecondarySortField,
ThirdSortField e FourthSortField não têm efeito.

[Link] SecondarySortAscending
Quando esta propriedade está 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.

[Link] SecondarySortField
Determina o Campo secundário para a ordenação dos Eventos em um E3Alarm. O nome do Campo deve ser
sempre especificado em inglês. Consulte os Campos disponíveis no Manual do Usuário do Elipse E3. O valor padrão
desta propriedade é uma String vazia. Esta propriedade não tem efeito quando a propriedade PrimarySortField é
configurada como uma String vazia.

[Link] ShowConnectionStatusBar
Mostra ou esconde a barra de status de conexões de um E3Alarm. O valor padrão desta propriedade é Falso.

[Link] ShowCriticalPriority
Se esta propriedade está configurada para Verdadeiro, mostra os Alarmes com severidade Crítica. O valor padrão
desta propriedade é Verdadeiro.

[Link] ShowHighPriority
Se esta propriedade está configurada para Verdadeiro, mostra os Alarmes com severidade Alta. O valor padrão
desta propriedade é Verdadeiro.

[Link] ShowIcon
Permite mostrar ou esconder o ícone na primeira coluna dos Eventos. O valor padrão desta propriedade é
Verdadeiro.

180 Visualização
[Link] ShowLowPriority
Se esta propriedade está configurada para Verdadeiro, mostra os Alarmes com severidade Baixa. O valor padrão
desta propriedade é Verdadeiro.

[Link] ShowMediumPriority
Se esta propriedade está configurada para Verdadeiro, mostra os Alarmes com severidade Média. O valor padrão
desta propriedade é Verdadeiro.

[Link] SimpleAreaFilter
Quando esta propriedade é igual a Verdadeiro, o comportamento de filtragem pelo nome de Área de Alarmes é
baseado apenas na coincidência da parte inicial do nome. Quando é igual a Falso, o comportamento leva em conta
todo o nome da Área, mas permite o uso de caracteres curinga e múltiplos Filtros de Área, que devem ser separados
por dois pontos. Consulte também a propriedade AreaFilter, que especifica o Filtro por nome de Área.

[Link] ThirdSortAscending
Quando esta propriedade está 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.

[Link] ThirdSortField
Determina o Campo terciário para a ordenação dos Eventos em um E3Alarm. O nome do Campo deve ser sempre
especificado em inglês. Consulte os Campos disponíveis no Manual do Usuário do Elipse E3. O valor padrão desta
propriedade é uma String vazia. Esta propriedade não tem efeito quando as propriedades PrimarySortField ou
SecondarySortField são configuradas como uma String vazia.

4.4.4 Coleção de Campos

Esta seção contém informações sobre métodos e propriedades do objeto Coleção de Campos (AlarmFieldCollection).
Este objeto não possui eventos associados.

NOTA
A Coleção de Campos pode ser acessada através da propriedade Fields do objeto E3Alarm.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Campos (AlarmFieldCollection).

[Link].1 Item
Item(Index)
Retorna um objeto Campo da Coleção de Campos, 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 Campo indicado
na propriedade Name.

[Link].2 MoveAlarmField
MoveAlarmField(Index, NewPosition)
Muda a ordem de um Campo de Alarme na Coleção de Campos em tempo de execução. O parâmetro Index indica o
nome, que corresponde à propriedade Name, ou o índice, que corresponde à propriedade Index, do Campo cuja
ordem deve ser modificada. O parâmetro NewPosition indica a nova posição do Campo na Coleção de Campos.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Campos (AlarmFieldCollection).

[Link].1 Count
Contém o número de Campos na Coleção de Campos. Esta propriedade é somente de leitura.

Visualização 181
[Link] Campo
Esta seção contém informações sobre as propriedades do objeto Campo da Coleção de Campos (AlarmField). Este
objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Campo da Coleção de Campos (AlarmField).

[Link].1.1 AckOnClick
Habilita ou desabilita o reconhecimento do Alarme correspondente à coluna deste Campo em um E3Alarm. Os
valores possíveis para esta propriedade são 0: Não reconhece o Alarme (padrão), 1: Reconhece o Alarme com um
clique simples ou 2: Reconhece o Alarme com um duplo clique.

[Link].1.2 AllowBlink
Habilita ou desabilita um efeito de pisca na coluna deste Campo em um E3Alarm. O valor padrão desta propriedade
é desabilitada.

[Link].1.3 FieldId
Identificador único da coluna deste Campo em um E3Alarm. Os valores possíveis desta propriedade estão
descritos na tabela a seguir.
Valores possíveis para a propriedade FieldId
VALOR COLUNA DESCRIÇÃO
1 AckRequired Evento precisa de reconhecimento
manual (Verdadeiro) ou automático
(Falso)

2 Acked Evento foi reconhecido ou não

3 ActorID Nome do operador que reconheceu

este Evento

4 ChangeMask Não é usado e o valor é sempre igual

a 0 (zero)

5 ConditionName Nome da condição, no caso de um

Alarme (Banda Morta, Digital,
Discreto, Nível ou Taxa de Variação)

6 ConditionActive Indica se a Fonte de Alarmes está em

Alarme ou não

7 Cookie Valor usado internamente pelo

Servidor de Alarmes

8 Enabled Determina se a verificação de Alarme

está habilitada ou não

9 EventCategory Categoria do Evento. Para Alarmes,

os valores possíveis são Banda
Morta, Digital, Discreto, Nível ou
TaxaDeVariação

10 EventType Tipo de Evento

11 Message Texto configurado na Fonte de

Alarme

12 Quality Qualidade do valor da Fonte de

Alarme no momento de um Evento

13 Severity Valor da severidade configurada na

Fonte de Alarme

14 Source Expressão utilizada para avaliar as

condições de Alarme

182 Visualização
 VALOR COLUNA DESCRIÇÃO
15 SubConditionName Nome da sub-condição, se é um
Evento de Alarme

16 EventTime Data e hora de um Evento

17 EventTimeUTC Data e hora de um Evento, no

formato UTC

18 CurrentValue Valor atual de uma Fonte de Alarme,

como um número de ponto flutuante

19 AlarmArea Nome da Área a qual uma Fonte de

Alarme pertence

20 AlarmSourceName Nome da Fonte de Alarme

21 EventTimeMS Data e hora de um Evento, em

milissegundos

22 InTime Data e hora de entrada de um Evento

23 InTimeMS Date e hora de entrada de um

Evento, em milissegundos

24 OutTime Data e hora de saída de um Evento

25 OutTimeMS Data e hora de saída de um Evento,

em milissegundos

26 AckTime Data e hora do reconhecimento de

um Alarme

27 AckTimeMS Data e hora do reconhecimento de

um Alarme, em milissegundos

28 FullAlarmSourceName Nome completo de uma Fonte de

Alarme

29 FormattedValue Valor formatado

30 InTimeDbl Data e hora de entrada de um

Evento, como um número de ponto
flutuante

31 OutTimeDbl Data e hora de saída de um Evento,

como um número de ponto flutuante

32 AckTimeDbl Data e hora de reconhecimento de

um Evento, como um número de
ponto flutuante

33 EventTimeDbl Data e hora de um Evento, como um

número de ponto flutuante

34 EventCLSID Identificador único de um Evento

35 ActiveSource Fonte de Medida ativa da Fonte de

Alarme no momento de um Evento

36 Unbound Indica se o Evento está vinculado a

uma Fonte de Alarme ou não

37 Deleted Indica se o Evento foi removido ou

não

38 AllowShelving Indica se o Alarme ou Evento permite

o arquivamento ou não

39 Shelved Indica se o Alarme ou Evento foi

arquivado ou não

40 ShelvedTime Data e hora do arquivamento de um

Alarme ou Evento

Visualização 183
 VALOR COLUNA DESCRIÇÃO
41 ShelvedOutTime Data e hora de desarquivamento ou 0
(zero) caso um Alarme ou Evento
ainda não tenha sido desarquivado

42 ShelveDuration Tempo de duração, em minutos, que

um Alarme ou Evento esteve
arquivado

43 ShelveMaxDuration Duração máxima, em minutos, que

um Alarme ou Evento pode
permanecer arquivado

44 ShelveCount Número de vezes que um Alarme ou

Evento foi arquivado

45 ShelveMaxCount Número máximo permitido de

arquivamentos de um Alarme ou
Evento

46 ShelveActorID Nome do operador responsável pelo

arquivamento de um Alarme ou
Evento

47 ShelveReason Motivo do arquivamento de um

Alarme ou Evento

48 E3TimeStamp Data e hora da ocorrência de um

Evento no formato do Elipse E3

49 Suppressed Indica se o Alarme foi suprimido ou

não

50 SuppressedTime Data e hora da supressão do Alarme

51 SequentialNumber Número sequencial do Alarme

52 AlarmState Estado atual do Alarme

53 ShelvedExpirationTime Indica a data e hora programada

para que este Alarme ou Evento saia
da condição de arquivamento

54 OutOfService Identifica se um Alarme foi suprimido

usando o tipo Fora de Serviço (Out-
of-Service)

55 OutOfServiceTime Registra a data e a hora em que um

Alarme foi suprimido usando o tipo
Fora de Serviço (Out-of-Service)

56 ReturnToServiceTime Registra a data e a hora em que um

Alarme suprimido usando o tipo Fora
de Serviço (Out-of-Service) voltou a
operar normalmente

57 OutOfServiceReason Motivo pelo qual um Alarme foi

suprimido usando o tipo Fora de
Serviço (Out-of-Service) por um
operador

58 OutOfServiceActorID Operador que realizou a supressão

de um Alarme usando o tipo Fora de
Serviço (Out-of-Service)

[Link].1.4 Format
Formato aplicado na coluna deste Campo para visualização em um E3Alarm. O valor padrão desta propriedade é
uma String vazia, ou seja, sem formatação.

184 Visualização
[Link].1.5 Index
Índice deste Campo na Coleção de Campos. Esta propriedade é somente de leitura.

[Link].1.6 Name
Nome que identifica este Campo. Consulte a propriedade geral Name para mais informações sobre os caracteres
permitidos no nome deste objeto.

[Link].1.7 UseFormat
Habilita ou desabilita o uso do formato especificado na propriedade Format à coluna deste Campo em um
E3Alarm. O valor padrão desta propriedade é desabilitada.

[Link].1.8 Visible
Habilita ou desabilita a visibilidade deste Campo no E3Alarm. O valor padrão desta propriedade é Verdadeiro.

[Link].1.9 Width
Indica a largura da coluna deste Campo, em pixels, em um E3Alarm. O valor padrão desta propriedade é 80 pixels.

4.4.5 Coleção de Conexões

Esta seção contém informações sobre métodos e propriedades do objeto Coleção de Conexões
(AlarmConnectionCollection). Este objeto não possui eventos associados.

NOTA
A Coleção de Conexões pode ser acessada através da propriedade Connections dos objetos Filtro de Alarmes e
E3Alarm.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Conexões (AlarmConnectionCollection).

[Link].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. Consulte a propriedade geral Name para
mais informações sobre os caracteres permitidos nos nomes de objetos.

[Link].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).

[Link].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.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Conexões (AlarmConnectionCollection).

[Link].1 Count
Contém o número de Conexões na Coleção de Conexões. Esta propriedade é somente de leitura.

Visualização 185
[Link] Conexão
Esta seção contém informações sobre as propriedades do objeto Conexão da Coleção de Conexões
(AlarmConnection). Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Conexão da Coleção de Conexões
(AlarmConnection).

[Link].1.1 AlarmServer
Nome do Servidor de Alarmes, que pode estar tanto em um Domínio local quanto em um Domínio remoto.

[Link].1.2 ConnectionName
Nome que identifica esta Conexão. Consulte a propriedade geral Name para mais informações sobre os caracteres
permitidos no nome deste objeto.

[Link].1.3 ConnectionStatus
Status atual da Conexão. Esta propriedade é somente de leitura. Os valores possíveis para esta propriedade são 0
- Não conectado: Não está conectada ao Servidor de Alarmes selecionado (padrão), 1 - Conectado: Está conectada
ao Servidor de Alarmes selecionado, 2 - Filtro não configurado: O Filtro da Conexão, ou seja, a propriedade
FilterConnection, não está configurado corretamente, 3 - Servidor de Alarmes não configurado: O Servidor de
Alarmes, ou seja, a propriedade AlarmServer, não está configurado, 4 - Erro inesperado: Houve um erro inesperado
na Conexão ou 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 Elipse E3 ou Elipse
Power anterior à 4.7.

[Link].1.4 DomainName
Nome amigável para identificar o Domínio onde está o Servidor de Alarmes selecionado. Este nome é mostrado na
coluna Domínio de Origem do E3Alarm.

[Link].1.5 FilterConnection
Nome do objeto Filtro que contém a configuração do Filtro de Alarmes, presente na Coleção de Filtros.

4.4.6 Coleção de Eventos

Esta seção contém informações sobre métodos e propriedades do objeto Coleção de Eventos (EventStatusCollection).
Este objeto não possui eventos associados.

NOTA
A Coleção de Eventos pode ser acessada através da propriedade Events dos objetos Filtro de Alarmes e E3Alarm.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Eventos (EventStatusCollection).

[Link].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).

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Eventos (EventStatusCollection).

[Link].1 Count
Contém o número de Eventos na Coleção de Eventos. Esta propriedade é somente de leitura.

186 Visualização
[Link] Evento
Esta seção contém informações sobre as propriedades do objeto Evento da Coleção de Eventos (EventStatus). Este
objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Evento da Coleção de Eventos (EventStatus).

[Link].1.1 Acked
Informa se este Evento foi reconhecido (Verdadeiro) ou não (Falso). Esta propriedade é somente de leitura.

[Link].1.2 AckRequired
Determina o reconhecimento automático (Falso) ou manual (Verdadeiro) deste Evento. Esta propriedade é somente
de leitura.

[Link].1.3 AckTime
Registra a data e hora do Elipse E3 no momento em que este Evento é reconhecido, ou zero (30/12/1899)
enquanto este Evento não é reconhecido. No caso de Eventos que não pedem reconhecimento, esta propriedade
assume a data e hora do Elipse E3 no momento em que este Evento é ativado. Esta propriedade é somente de leitura.

[Link].1.4 ActiveSource
Fonte de Medida ativa da Fonte de Alarme no momento deste Evento. Esta propriedade é somente de leitura.

[Link].1.5 ActorID
Nome do operador que reconheceu este Evento. Esta propriedade é somente de leitura e o valor pode ser:
· O usuário logado no Elipse E3 Viewer, quando o reconhecimento é realizado no E3Alarm, ou "Sem usuário" se
não há usuário logado
· "System", quando o reconhecimento é automático, ou seja, para Eventos que pedem reconhecimento
· Um nome passado por script, como por exemplo ao usar os métodos AckAllAlarms, AckArea ou o método Ack
da Fonte de Alarmes

[Link].1.6 AlarmSourceName
Contém o nome da Fonte de Alarme. Esta propriedade é somente de leitura.

[Link].1.7 AlarmState
Indica o estado atual de um Alarme. Os valores possíveis para esta propriedade são 1: Alarme saiu da condição de
alarme e foi reconhecido, 2: Alarme ativo e necessita reconhecimento, 3: Alarme em condição ativa e reconhecido, 4:
Alarme em condição inativa e necessita reconhecimento, 5: Alarme suprimido usando o tipo Arquivamento, 6: Alarme
suprimido usando o tipo Condição, 7: Alarme suprimido usando o tipo Fora de Serviço, 8: Alarme ativo e não
necessita reconhecimento, 9: Evento ou 10: Alarme inserido via método LogTrackingEvent do Servidor de Alarmes.
Esta propriedade é somente de leitura.

[Link].1.8 AllowShelving
Indica se este Alarme ou Evento pode ou não ser arquivado. Esta propriedade é somente de leitura.

[Link].1.9 Area
Para Eventos de Alarmes, é o nome da Área a qual a Fonte de Alarmes pertence. Esta propriedade é somente de
leitura.

[Link].1.10 ConditionActive
Indica se a Fonte de Alarmes está em Alarme (Verdadeiro) ou não (Falso). Esta propriedade é somente de leitura.

Visualização 187
[Link].1.11 ConditionName
Nome da condição, se este é um Evento de Alarme. Os valores possíveis para esta propriedade são Banda Morta:
Fonte de Alarme do tipo Banda Morta, Digital: Fonte de Alarme do tipo Digital, Discreto: Fonte de Alarme do tipo
Discreto, Nível: Fonte de Alarme do tipo Analógico ou TaxaDeVariação: Fonte de Alarme do tipo Taxa de Variação.
Se este Evento não é um Alarme, esta propriedade é sempre uma String vazia. Esta propriedade é somente de leitura.

[Link].1.12 CurrentValue
Determina o valor da Fonte de Alarme, convertido para Double, no momento deste Evento. Para outros Eventos, o
valor desta propriedade é sempre 0 (zero). Esta propriedade é somente de leitura.

[Link].1.13 Deleted
Indica se este Evento foi removido. Esta propriedade é somente de leitura.

[Link].1.14 DomainName
Retorna o nome de Domínio da Conexão deste Evento. Este nome corresponde à coluna Domínio da lista de
Conexões disponível na aba Conexões do E3Alarm. Esta propriedade é somente de leitura.

[Link].1.15 E3TimeStamp
Data e hora em que este Evento ocorreu. Esta propriedade é somente de leitura.

[Link].1.16 Enabled
Determina se a verificação deste Alarme está habilitada (Verdadeiro) ou não (Falso). Esta propriedade é somente de
leitura.

[Link].1.17 EventCategory
Categoria deste Evento. Para Alarmes, os valores possíveis para esta propriedade são Banda Morta: Fonte de
Alarme do tipo Banda Morta, Digital: Fonte de Alarme do tipo Digital, Discreto: Fonte de Alarme do tipo Discreto,
Nível: Fonte de Alarme do tipo Analógico ou TaxaDeVariação: Fonte de Alarme do tipo Taxa de Variação. Esta
propriedade é somente de leitura.

[Link].1.18 EventCLSID
Identificador único para toda a vida deste Evento. Quando um Evento novo ocorre em uma Fonte, é gerado um
novo número de EventCLSID. Assim, este Evento mantém este mesmo CLSID no banco de dados, enquanto não sair da
lista de Eventos ativos e não reconhecidos. Esta propriedade é somente de leitura.

[Link].1.19 EventTime
Data e hora do valor da Fonte de Alarme no momento deste Evento. Esta propriedade é somente de leitura.

[Link].1.20 EventTimeUTC
Data e hora do valor da Fonte de Alarme no momento deste Evento, com relação ao horário de Greenwich. O valor
é o mesmo da propriedade EventTime, e é mantido no Elipse E3 por questões de compatibilidade. Esta propriedade
é somente de leitura.

[Link].1.21 EventType
Tipo deste Evento. Para Eventos de Alarme, é sempre "Condition". Esta propriedade é somente de leitura.

[Link].1.22 FormattedValue
Mostra o valor formatado da Fonte de Alarme que vai para este Evento. Esta propriedade é somente de leitura.

[Link].1.23 FullAlarmSourceName
Registra o caminho completo da Fonte de Alarme, incluindo Áreas, nome da Configuração de Alarmes e de
possíveis Pastas onde esta possa estar inserida, como por exemplo "Pasta1.ConfigAlarmes1.Area1.FonteAlarme1". Esta
propriedade é somente de leitura.

188 Visualização
[Link].1.24 InTime
Registra a data e hora do valor no momento em que entra na condição de alarme. Esta propriedade é somente de
leitura.

[Link].1.25 Message
É o texto configurado na Fonte de Alarme. Esta propriedade é somente de leitura.

[Link].1.26 OutOfService
Identifica se um Alarme foi suprimido usando o tipo Fora de Serviço (Out-of-Service).

[Link].1.27 OutOfServiceActorID
Operador que realizou a supressão de um Alarme usando o tipo Fora de Serviço (Out-of-Service).

[Link].1.28 OutOfServiceReason
Motivo pelo qual um Alarme foi suprimido usando o tipo Fora de Serviço (Out-of-Service) por um operador.

[Link].1.29 OutOfServiceTime
Registra a data e a hora em que um Alarme foi suprimido usando o tipo Fora de Serviço (Out-of-Service).

[Link].1.30 OutTime
Registra a data e hora do valor no momento em que sai da condição de alarme, ou zero (30/12/1899) enquanto o
Evento ainda não tenha saído da condição ativa. Esta propriedade é somente de leitura.

[Link].1.31 Quality
Qualidade do valor da Fonte de Alarme no momento deste Evento. Esta propriedade é somente de leitura. Os
valores possíveis para esta propriedade são 0 - 63: Qualidade ruim, 64 - 127: Qualidade incerta, 128 - 191: Valor
indefinido ou 192 - 255: Qualidade boa. Se este Evento não é um Alarme, esta propriedade é igual a uma String vazia.
Exemplos de conteúdo desta propriedade são "Ruim (0)", "Incerta (64)", "?? (128)" e "Boa (192)".

[Link].1.32 ReturnToServiceTime
Registra a data e a hora em que um Alarme suprimido usando o tipo Fora de Serviço (Out-of-Service) voltou a
operar normalmente.

[Link].1.33 Severity
Valor de severidade configurado na Fonte de Alarme. Os valores possíveis para esta propriedade são -2: Crítica, 0:
Alta, 1: Média ou 2: Baixa. Esta propriedade é somente de leitura.

[Link].1.34 ShelveActorID
Nome do operador que arquivou este Alarme ou Evento. Esta propriedade é somente de leitura e o valor pode ser
o usuário logado no Elipse E3 Viewer, quando o arquivamento é realizado no E3Alarm, "Sem usuário" se não há
usuário logado, ou "System" quando o arquivamento é automático, ou seja, para Alarmes ou Eventos que pedem
arquivamento.

[Link].1.35 ShelveCount
Número de vezes que este Alarme ou Evento foi arquivado. Esta propriedade é somente de leitura.

[Link].1.36 Shelved
Indica se este Alarme ou Evento foi ou não arquivado. Esta propriedade é somente de leitura.

[Link].1.37 ShelvedExpirationTime
Data e hora em que este Alarme ou Evento está programado para sair da condição de arquivamento. Esta
propriedade é somente de leitura.

Visualização 189
[Link].1.38 ShelvedOutTime
Registra a data e hora do momento em que este Alarme ou Evento é desarquivado, ou zero (30/12/1899) enquanto
este Alarme ou Evento ainda não tenha sido desarquivado. Esta propriedade é somente de leitura.

[Link].1.39 ShelvedTime
Registra a data e hora do momento em que este Alarme ou Evento é arquivado. Esta propriedade é somente de
leitura.

[Link].1.40 ShelveDuration
Tempo, em minutos, que este Alarme ou Evento esteve arquivado. Esta propriedade é somente de leitura.

[Link].1.41 ShelveMaxCount
Número máximo de vezes que este Alarme ou Evento pode ser arquivado. Esta propriedade é somente de leitura.

[Link].1.42 ShelveMaxDuration
Tempo máximo, em minutos, que este Alarme ou Evento pode permanecer arquivado. Esta propriedade é somente
de leitura.

[Link].1.43 ShelveReason
Motivo pelo qual este Alarme ou Evento foi arquivado. Esta propriedade é somente de leitura.

[Link].1.44 Source
Para Eventos de Alarme, informa a expressão utilizada para avaliar as condições de Alarme. Esta propriedade é
somente de leitura.

[Link].1.45 SubConditionName
Nome da subcondição, se este é um Evento de Alarme. Os valores possíveis para esta propriedade são BM: Alarme
de Banda Morta, DIG: Alarme Digital, TV: Alarme Taxa de Variação, LOLO: Alarme Analógico na faixa Muito Baixo, LO:
Alarme Analógico na faixa Baixo, HI: Alarme Analógico na faixa Alto ou HIHI: Alarme Analógico na faixa Muito Alto.

NOTA
Para Fontes de Alarme do tipo Discreto, esta propriedade assume o nome da Subcondição definida pelo usuário,
disponível na aba Discreto das propriedades deste tipo de Alarme.

Se este Evento não é um Alarme, esta propriedade é igual a uma String vazia. Esta propriedade é somente de leitura.

[Link].1.46 Unbound
Indica se este Evento está desvinculado de uma Fonte de Alarme. Esta propriedade é somente de leitura.

[Link].1.47 UserField
Esta propriedade recebe o índice ou o nome de um Campo de Usuário da Coleção de Campos de Usuário da Área
de Alarme, a propriedade UserFields, e retorna o objeto correspondente. Para mais informações sobre o objeto
retornado por esta propriedade, consulte o tópico Campo de Usuário de Alarmes. Esta propriedade é somente de
leitura.

4.4.7 Coleção de Filtros

Esta seção contém informações sobre métodos e propriedades do objeto Coleção de Filtros
(ConnectionFilterCollection). Este objeto não possui eventos associados.

NOTA
A Coleção de Filtros pode ser acessada através da propriedade Filters dos objetos Filtro de Alarmes e E3Alarm.

190 Visualização
[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Filtros (ConnectionFilterCollection).

[Link].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. Consulte a propriedade geral Name para mais
informações sobre os caracteres permitidos nos nomes de objetos.

[Link].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).

[Link].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.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Filtros (ConnectionFilterCollection).

[Link].1 Count
Contém o número de Filtros na Coleção de Filtros. Esta propriedade é somente de leitura.

[Link] Filtro
Esta seção contém informações sobre as propriedades do objeto Filtro da Coleção de Filtros (ConnectionFilter). Este
objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Filtro da Coleção de Filtros (ConnectionFilter).

[Link].1.1 AreaFilter
Controla as Áreas de Alarme visíveis no Filtro. Se o valor não é uma String vazia, são apresentados Eventos cujo
nome das Áreas comecem com o texto indicado. Por exemplo, se esta propriedade é igual a "Ana", são mostrados os
Alarmes de Áreas como "[Link]" ou "Analise", mas não "[Link]" ou "[Link]".
Quando a propriedade SimpleAreaFilter está configurada como Falso, a Área de Alarme também permite o uso de
caracteres curingas para a filtragem e múltiplos Filtros de Área, separados por dois pontos. Consulte a propriedade
AreaFilter do objeto Filtro de Alarme para informações sobre os caracteres curinga permitidos. O valor padrão desta
propriedade é uma String vazia, ou seja, sem filtragem por Área. Consulte também as propriedades CustomFilter,
SimpleAreaFilter, ShowCriticalPriority, ShowHighPriority, ShowMediumPriority e ShowLowPriority.

[Link].1.2 CustomFilter
Permite informar um Filtro personalizado para os Alarmes, na forma de uma expressão. Consulte a propriedade
CustomFilter do objeto Filtro de Alarmes para informações sobre os Campos disponíveis para utilização na
expressão deste Filtro. Os Campos definidos pelo usuário também podem ser utilizados na expressão do Filtro,
utilizando-se o nome definido no Servidor de Alarmes.
Ao todo, as mensagens que aparecem na listagem do Filtro sempre passam pelos seguintes Filtros:
· Filtro por tipo, definido na propriedade FilterType
· Filtro por severidade, definido nas propriedades ShowCriticalPriority, ShowLowPriority, ShowMediumPriority e
ShowHighPriority

Visualização 191
 · Filtro por área, definido nas propriedades AreaFilter e SimpleAreaFilter
· Filtro por esta propriedade
· Filtro do Sumário de Alarmes, equivalente à expressão "Enabled AND (ConditionActive OR (AckRequired AND NOT
Acked))"

Para exemplos de uso desta propriedade, consulte a propriedade CustomFilter do objeto E3Alarm. O valor padrão
desta propriedade é uma String vazia.

[Link].1.3 FilterName
Nome que identifica este Filtro. Consulte a propriedade geral Name para mais informações sobre os caracteres
permitidos no nome deste objeto.

[Link].1.4 FilterType
Efetua os Filtros de Alarme. Os valores possíveis para esta propriedade são 1 - OnlyAlarms: Mostra apenas
Alarmes (padrão), 2 - OnlyEvents: Mostra apenas Eventos ou 3 - AlarmsAndEvents: Mostra tanto Alarmes quanto
Eventos.

[Link].1.5 IgnoreDiacritics
Se configurada para Verdadeiro, ignora caracteres acentuados na expressão de busca da propriedade
CustomFilter. Caso contrário, os caracteres acentuados na expressão de busca são considerados.

[Link].1.6 ShowCriticalPriority
Se esta propriedade está configurada para Verdadeiro, mostra os Alarmes com severidade Crítica. O valor padrão
desta propriedade é Verdadeiro.

[Link].1.7 ShowHighPriority
Se esta propriedade está configurada para Verdadeiro, mostra os Alarmes com severidade Alta. O valor padrão
desta propriedade é Verdadeiro.

[Link].1.8 ShowLowPriority
Se esta propriedade está configurada para Verdadeiro, mostra os Alarmes com severidade Baixa. O valor padrão
desta propriedade é Verdadeiro.

[Link].1.9 ShowMediumPriority
Se esta propriedade está configurada para Verdadeiro, mostra os Alarmes com severidade Média. O valor padrão
desta propriedade é Verdadeiro.

[Link].1.10 SimpleAreaFilter
Quando esta propriedade é igual a Verdadeiro, o comportamento de filtragem pelo nome de Área de Alarmes é
baseado apenas na coincidência da parte inicial do nome. Quando é igual a Falso, o comportamento leva em conta
todo o nome da Área, mas permite o uso de caracteres curinga e múltiplos Filtros de Área, que devem ser separados
por dois pontos. Consulte também a propriedade AreaFilter, que especifica o Filtro por nome de Área. O valor
padrão desta propriedade é Verdadeiro.

4.4.8 Cor do Alarme

Esta seção contém informações sobre métodos e propriedades do objeto Cor do Alarme (E3AlarmColorObject). Este
objeto não possui eventos associados.

NOTA
O objeto Cor do Alarme pode ser acessado utilizando-se as propriedades ColorAckedAlarm, ColorActiveAlarm,
ColorActiveEvent e ColorNAckAlarm do E3Alarm.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Cor do Alarme (E3AlarmColorObject).

192 Visualização
[Link].1 SetConfig
SetConfig([BackgroundColor], [TextColor], [BlinkMode], [TextColor2])
Configura a cor de fundo, de texto, o modo de pisca e a cor do texto quando o modo de pisca é igual a 3 (três) para
o Alarme ou severidade. Caso o objeto Cor do Alarme esteja configurando uma severidade específica, ou seja,
diferente de -1 (menos um), os parâmetros informados forçam automaticamente a atualização das propriedades de
redefinição equivalentes, ou seja, a propriedade OverrideBackgroundColor para o parâmetro BackgroundColor, a
propriedade OverrideTextColor para o parâmetro TextColor, a propriedade OverrideBlinkMode para o parâmetro
BlinkMode e a propriedade TextColor2 para o parâmetro TextColor2 se a propriedade BlinkMode é igual a 3 (três). Se
a propriedade Severity é igual a -1 (menos um), então a configuração é realizada para os valores padrão de cor de
fundo, de texto e modo de pisca do Alarme, e esta configuração pode ou não se propagar para cada severidade,
dependendo dos valores de redefinição de cada uma das propriedades equivalentes. O código a seguir contém um
exemplo de uso deste método.
' Configura apenas a propriedade BackgroundColor
' do Alarme ativo com severidade alta
Set AlarmeAtivoAlta = [Link]("E3Alarm1").ColorActiveAlarm(0)
[Link] RGB(0,0,255)

' Configura apenas a propriedade TextColor

' do Alarme ativo com severidade média
Set AlarmeAtivoMedia = [Link]("E3Alarm1").ColorActiveAlarm(1)
[Link] , RGB(255,255,255)

' Configura apenas a propriedade BlinkMode

' do Alarme ativo com severidade baixa
Set AlarmeAtivoBaixa = [Link]("E3Alarm1").ColorActiveAlarm(2)
[Link] ,,1

' Configura todas as propriedades do Alarme ativo

Set AlarmeAtivo = [Link]("E3Alarm1").ColorActiveAlarm(-1)
[Link] RGB(0,255,0), RGB(0,128,0), 2

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Cor do Alarme (E3AlarmColorObject).

[Link].1 BackgroundColor
Define a cor de fundo para o Alarme ou severidade.

[Link].2 BlinkMode
Define o modo de pisca para o Alarme ou severidade. Os valores possíveis para esta propriedade são 0: Não
pisca, 1: Pisca o fundo e o texto, 2: Pisca apenas o texto ou 3: Pisca o texto trocando para a cor definida na
propriedade TextColor2.

[Link].3 OverrideBackgroundColor
Define se a cor de fundo configurada na propriedade BackgroundColor é ou não aplicada à severidade. Se esta
propriedade está configurada em Falso, a severidade usa a cor de fundo definida como padrão para o Alarme.

[Link].4 OverrideBlinkMode
Define se o modo de pisca configurado na propriedade BlinkMode é ou não aplicado à severidade. Se esta
propriedade está configurada em Falso, a severidade usa o modo de pisca definido como padrão para o Alarme.

[Link].5 OverrideTextColor
Define se a cor do texto configurada na propriedade TextColor é ou não aplicada à severidade. Se esta
propriedade está configurada em Falso, a severidade usa a cor do texto configurada como padrão para o Alarme.

[Link].6 Severity
Retorna a severidade de um Alarme. Os valores possíveis para esta propriedade são -2: Crítica, -1: Padrão, 0: Alta,
1: Média ou 2: Baixa. Esta propriedade é somente de leitura.

Visualização 193
[Link].7 TextColor
Define a cor do texto para o Alarme ou severidade.

[Link].8 TextColor2
Define a cor do texto para o Alarme ou severidade quando a propriedade BlinkMode está configurada para o
valor 3 (três).

4.5 E3Browser
Esta seção contém informações sobre eventos, métodos e propriedades de um objeto E3Browser.

4.5.1 Eventos
Esta seção contém informações sobre os eventos do objeto E3Browser.

[Link] KeyPress
KeyPress(KeyAscii)
Ocorre quando um 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 no parâmetro KeyAscii), ou seja, este
evento ocorre quando qualquer das teclas a seguir é pressionada:
· 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

Este evento não ocorre nas seguintes condições:

· Pressionando-se a tecla TAB
· Pressionando-se a tecla ENTER
· Pressionando-se a tecla DEL, pois esta tecla não é padrão ANSI
· Pressionando-se as setas do teclado
· Quando uma tecla move o foco de um objeto para outro

Enquanto o usuário pressiona uma tecla que produz um código ANSI, um E3Browser recebe o evento KeyDown e este
evento repetidamente. Quando o usuário libera a tecla, ocorre um evento KeyUp. Para monitorar o estado físico do
teclado ou manipular teclas não reconhecidas por este evento, tais como teclas de função e navegação, utilize os
eventos KeyDown e KeyUp.

NOTA
Para uma lista com todos os códigos de tecla disponíveis para o parâmetro KeyAscii, consulte o artigo Keys Enum no
Microsoft Learn.

[Link] MouseMove
MouseMove()
Ocorre quando o ponteiro do mouse se move sobre um E3Browser.

[Link] OnDrawRow
OnDrawRow(Selected, Row, TextColor, BackColor)
Este evento possui o parâmetro Selected, que indica se a linha está selecionada, o parâmetro Row, que indica o
número da linha sendo desenhada, o parâmetro TextColor, que indica a cor do texto da linha e o parâmetro BackColor,
que indica a cor de fundo do texto da linha.
Se a cor é modificada dentro deste evento, esta modificação é usada por um E3Browser no desenho da linha. Outra
modificação importante é que se o método GetColumnValue é usado neste evento, os valores retornados são os da
linha sendo desenhada, e não os da linha selecionada.

194 Visualização
[Link] OnFormatCell
OnFormatCell(Column, FieldName, OriginalValue, FormattedValue)
Este evento permite personalizar o formato do texto das células de um E3Browser. Este evento possui o parâmetro
Column, que indica o índice da coluna visível de um E3Browser, iniciando em 0 (zero), e permite identificar a coluna da
célula que está sendo formatada, o parâmetro FieldName, que indica o texto com o nome do campo da coluna sendo
formatada, o parâmetro OriginalValue, que indica o valor não formatado da célula, com o tipo de dados Variant, e o
parâmetro FormattedValue, que indica o valor formatado, com o tipo de dados Variant, de acordo com a
configuração da coluna de um E3Browser. Se este parâmetro é modificado dentro deste evento, permite alterar o
texto formatado. O exemplo a seguir demonstra a formatação de campos de Alarmes.
Sub E3Browser1_OnFormatCell(Column, FieldName, OriginalValue, FormattedValue)
If Column = 15 Then
If Not IsNull(OriginalValue) Then
FormattedValue = SourceTypeName(OriginalValue)
ElseIf Column = 9 Then
If OriginalValue = 0 Then
FormattedValue = "Alta"
ElseIf OriginalValue = 1 Then
FormattedValue = "Média"
Else
FormattedValue = "Baixa"
End If
End If
End Sub

4.5.2 Métodos
Esta seção contém informações sobre os métodos do objeto E3Browser.

[Link] AboutBox
AboutBox()
Este método exibe uma caixa de diálogo com informações sobre versão e copyright de um E3Browser.

[Link] ClearFields
ClearFields()
Limpa a formatação de colunas e linhas de um E3Browser.

[Link] 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.

[Link] Refresh
Refresh()
Atualiza os dados de uma Consulta sem recarregar a configuração atual. Este método simula o comportamento de um
clique com o botão direito do mouse em um E3Browser quando a propriedade RightClickRefresh está configurada
para Verdadeiro.

[Link] Requery
Requery()
Este método atualiza a Consulta, utilizando a configuração atual, e retorna os dados para um E3Browser.

[Link] RetrieveE3QueryFields
RetrieveE3QueryFields()
Este método lê a estrutura de dados da Consulta e atualiza a formatação de um E3Browser com os campos definidos
nesta Consulta. Se este método é bem sucedido, retorna Verdadeiro. Caso contrário, retorna Falso. Este método é
especialmente útil quando é preciso usar um único E3Browser para exibir dados de diferentes tabelas ou Consultas.

Visualização 195
4.5.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto E3Browser.

[Link] AllowColumnResize
Habilita ou desabilita a configuração do tamanho das colunas da grade, em tempo de execução. Se esta
propriedade está configurada para Falso, o tamanho das colunas é fixo e não pode ser modificado.

[Link] AllowHeaderSort
Habilita ou desabilita a ordenação pelo cabeçalho das colunas de um E3Browser em tempo de execução. O valor
padrão desta propriedade é Verdadeiro.

[Link] AllowRowResize
Habilita ou desabilita a configuração do tamanho das linhas da grade, em tempo de execução. Se esta propriedade
está configurada para Falso, o tamanho das linhas é fixo e não pode ser modificado.

[Link] ColumnTextAlignment
Determina o alinhamento do texto das colunas de um E3Browser. Os valores possíveis para esta propriedade são
0: taAlignLeft (padrão), 1: taAlignCenter ou 2: taAlignRight. Ao selecionar um valor para esta propriedade, todos os
valores com o mesmo alinhamento na coluna Alinhamento do Texto da lista de campos da aba Consulta da Janela
de Propriedades de um E3Browser são modificados para o valor selecionado.

[Link] ColumnWidth
Determina a largura das colunas de um E3Browser, em pixels.

[Link] CurSel
Indica a posição atual do cursor de um E3Browser, ou seja, o índice da linha em que o cursor está posicionado.

[Link] E3Query
Retorna o objeto Consulta de um E3Browser, para acesso às propriedades deste objeto. Esta propriedade é
somente de leitura.

[Link] Fields
Retorna a Coleção de Campos de um E3Browser, que contém a lista com todos os campos de uma tabela,
tornando possível a referência através dos itens desta Coleção. Esta propriedade é somente de leitura. O valor
padrão desta propriedade é vazio. O script a seguir contém um exemplo de uso desta propriedade.
Sub E3Browser1_Click()
' Troca a cor do campo Campo1
Set fields = [Link]("E3Browser").Fields
Set campo1 = [Link]("Campo1")
[Link] = RGB(255, 0, 0) ' Vermelho
' Mostra quantos campos tem o E3Browser
MsgBox [Link]
' Mostra o nome dos campos do E3Browser
For Each field In fields
MsgBox [Link]
Next
End Sub

Para mais informações sobre a Coleção retornada nesta propriedade, consulte o tópico Coleção de Campos de um
E3Browser.

[Link] FixedBkColor
Especifica a cor de fundo do cabeçalho de um E3Browser. O valor padrão desta propriedade é a cor RGB(240, 240,
240). Esta propriedade corresponde à opção Cor de fundo do cabeçalho na aba Cores da Janela de Propriedades
de um E3Browser.

196 Visualização
[Link] FixedColumnWidth
Determina a largura da primeira coluna de um E3Browser, em pixels. O valor padrão desta propriedade é 30 pixels.

[Link] FixedRowFont
Determina a fonte do texto utilizada na linha de cabeçalho de um E3Browser. Esta propriedade não pode ser
utilizada em scripts ou em Associações, e é configurada somente via Elipse E3 Studio. O valor padrão desta
propriedade é a fonte Arial. Consulte o tópico Fonte para mais informações sobre as sub-propriedades desta
propriedade.

[Link] FixedRowHeight
Determina a altura, em pixels, da linha de cabeçalho de um E3Browser. O valor padrão desta propriedade é 20.

[Link] FixedTextColor
Especifica a cor do cabeçalho de um E3Browser. O valor padrão desta propriedade é preto (RGB(0, 0, 0)). Esta
propriedade corresponde à opção Cor do texto do cabeçalho na aba Cores da Janela de Propriedades de um
E3Browser.

[Link] GridBkColor
Determina a cor de fundo da área de dados de um E3Browser. O valor padrão desta propriedade é branco
(RGB(255, 255, 255)). Esta propriedade corresponde à opção Cor de fundo do E3Browser na aba Cores da Janela de
Propriedades de um E3Browser.

[Link] GridFont
Determina a fonte utilizada nos textos da área de dados de um E3Browser. O valor padrão desta propriedade é a
fonte Arial. Esta propriedade não pode ser utilizada em scripts ou em Associações, e é configurada somente via Elipse
E3 Studio. Consulte o tópico Fonte para mais informações sobre as sub-propriedades desta propriedade.

[Link] GridLineColor
Determina a cor das linhas da grade de dados de um E3Browser. O valor padrão desta propriedade é prata
(RGB(192, 192, 192)). Esta propriedade corresponde à opção Cor da linha da grade na aba Cores da Janela de
Propriedades de um E3Browser.

[Link] GridLinesType
Determina o tipo de linhas a serem desenhadas na grade de dados de um E3Browser. Os valores possíveis para
esta propriedade são 0 - GLNone: Sem linhas separadoras, 1 - GLHorz: Somente linhas horizontais, 2 - GLVert:
Somente linhas verticais ou 3 - GLBoth: Linhas verticais e horizontais (padrão).

[Link] HeaderTextAlignment
Determina o alinhamento do texto do cabeçalho das colunas de um E3Browser. Os valores possíveis para esta
propriedade são 0: bhaLeft (padrão), 1: bhaCenter, 2: bhaRight ou 3: bhaFollowColumn. Ao selecionar a opção
bhaFollowColumn, o texto do cabeçalho das colunas é alinhado conforme especificado na coluna Alinhamento do
Texto da lista de campos da aba Consulta da Janela de Propriedades de um E3Browser.

[Link] HeaderWordWrap
Esta propriedade aplica uma quebra de linha no texto do cabeçalho das colunas de um E3Browser, permitindo
mostrar o texto completo do nome da coluna. Esta quebra de linha é aplicada somente onde há um espaço, tabulação
ou quebra de linha forçada no texto. Configurar esta propriedade em Verdadeiro não altera o valor da propriedade
FixedRowHeight, que controla a altura do cabeçalho das colunas. Caso o texto do cabeçalho não contenha espaços,
tabulações ou quebras de linha forçadas, o texto é truncado e são mostradas reticências no limite da largura da
coluna. Além disto, o alinhamento vertical do texto, normalmente centralizado, é alterado para um alinhamento pelo
topo. O valor padrão desta propriedade é Falso.

[Link] 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

Visualização 197
milissegundos. Quando esta propriedade é igual a 0 (zero), não há atualização dos dados e estes permanecem
inalterados. O valor desta propriedade deve ser maior que 1000 ms.

[Link] RightClickRefresh
Indica se o clique com o botão direito do mouse em um E3Browser causa uma atualização na Consulta. Se esta
propriedade está configurada para Falso, o clique com o botão direito do mouse em um E3Browser apenas seleciona
a célula indicada. O valor padrão desta propriedade é Verdadeiro.

[Link] RowHeight
Define a altura das linhas de um E3Browser, em pixels. O valor padrão desta propriedade é 20.

[Link] SelectRow
Estabelece a possibilidade de seleção das linhas de um E3Browser. Se esta propriedade está configurada para
Verdadeiro, é possível selecionar as linhas. Do contrário, as linhas não podem ser selecionadas.

[Link] ShowToolbar
Mostra ou esconde a barra de ferramentas de um E3Browser. O valor padrão desta propriedade é Verdadeiro.

[Link] SortColumn
Indica a coluna que deve ser usada para ordenação em um E3Browser. O valor padrão desta propriedade é -1
(menos um), ou seja, usa a ordenação da Consulta que fornece os dados. Configurar esta propriedade com um valor
menor que 1 (um) ou maior que o número de colunas remove a ordenação de um E3Browser. Por outro lado,
configurar esta propriedade sucessivas vezes com o mesmo valor de coluna altera a ordenação desta coluna, indicada
na propriedade SortOrder, para sem ordenação (SONoSort), com ordenação ascendente (SOAsc) e com ordenação
descendente (SODesc), e assim por diante, simulando um clique de mouse na respectiva coluna.

NOTAS
· Esta propriedade está disponível somente em tempo de execução.
· Configurar esta propriedade com um valor menor ou igual a 0 (zero) e a propriedade SortOrder com o valor 0
(zero, SONoSort) retorna a ordenação original dos dados da Consulta de um E3Browser.

[Link] SortOrder
Indica a ordenação dos dados com base na coluna indicada na propriedade SortColumn. Os valores possíveis
para esta propriedade são 0 - SONoSort: Sem ordenação (padrão), 1 - SOAsc: Ordenação ascendente ou 2 - SODesc:
Ordenação descendente.

NOTAS
· Esta propriedade está disponível somente em tempo de execução.
· Configurar esta propriedade com o valor 0 (zero, SONoSort) e a propriedade SortColumn com um valor menor
ou igual a 0 (zero) retorna a ordenação original dos dados da Consulta de um E3Browser.

[Link] SourceQuery
Contém uma referência para o objeto Consulta ao qual um E3Browser está associado.

NOTA
Para trocar a Consulta de um E3Browser por meio de um script, caso a nova Consulta modifique os campos da
Consulta original, além de alterar esta propriedade é preciso utilizar os métodos RetrieveE3QueryFields e Requery.

[Link] TextBkColor
Especifica a cor de fundo das células de dados de um E3Browser. O valor padrão desta propriedade é branco
(RGB(255, 255, 255)). Esta propriedade corresponde à opção Cor de fundo da célula na aba Cores da Janela de
Propriedades de um E3Browser.

198 Visualização
[Link] TextColor
Especifica a cor do texto de um E3Browser. O valor padrão desta propriedade é preto (RGB(0, 0, 0)). Esta
propriedade corresponde à opção Cor do texto da célula na aba Cores da Janela de Propriedades de um E3Browser.

[Link] TitleTipBkColor
Especifica a cor do fundo do texto da dica de um E3Browser. O valor padrão desta propriedade é branco
(RGB(255, 255, 225)). Esta propriedade corresponde à opção Cor de fundo da dica da célula na aba Cores da Janela
de Propriedades de um E3Browser.

[Link] TitleTipTextColor
Especifica a cor do texto da dica de um E3Browser. O valor padrão desta propriedade é preto RGB(0, 0, 0). Esta
propriedade corresponde à opção Cor do texto da dica da célula na aba Cores da Janela de Propriedades de um
E3Browser.

[Link] ToolbarBkColor
Especifica a cor de fundo da barra de ferramentas de um E3Browser. O valor padrão desta propriedade é a cor
RGB(240, 240, 240). Esta propriedade corresponde à opção Cor de fundo da barra de funções na aba Cores da
Janela de Propriedades de um E3Browser.

[Link] ToolbarFont
Determina a fonte utilizada nos textos da barra de ferramentas de um E3Browser. Esta propriedade não pode ser
utilizada em scripts ou em Associações, e é configurada somente via Elipse E3 Studio. O valor padrão desta
propriedade é a fonte Arial. Consulte o tópico Fonte para mais informações sobre as sub-propriedades desta
propriedade.

[Link] ToolbarForeColor
Especifica a cor de frente da barra de ferramentas de um E3Browser. O valor padrão desta propriedade é preto
(RGB(0, 0, 0)). Esta propriedade corresponde à opção Cor do texto da barra de funções na aba Cores da Janela de
Propriedades de um E3Browser.

4.5.4 Coleção de Campos de um E3Browser

Esta seção contém informações sobre métodos e propriedades do objeto Coleção de Campos de um E3Browser
(FieldCollection). Este objeto não possui eventos associados.

NOTA
A Coleção de Campos de um E3Browser pode ser acessada através da propriedade Fields de um E3Browser.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Campos de um E3Browser (FieldCollection).

[Link].1 Item
Item(Index)
Retorna um objeto Campo da Coleção de Campos de um E3Browser, 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 Campo, ou seja, a propriedade Name do objeto Campo de um E3Browser.

[Link].2 Remove
Remove(Index)
Remove um objeto Campo da Coleção de Campos de um E3Browser através do respectivo nome ou índice,
especificado pelo parâmetro Index.

Visualização 199
[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Campos de um E3Browser
(FieldCollection).

[Link].1 Count
Contém o número de Campos na Coleção de Campos de um E3Browser. Esta propriedade é somente de leitura.

[Link] Campo de um E3Browser

Esta seção contém informações sobre propriedades do objeto Campo de um E3Browser (Field). Este objeto não
possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Campo de um E3Browser (Field).

[Link].1.1 BkColor
Determina a cor de fundo de um Campo de um E3Browser. O valor padrão desta propriedade é a cor configurada
no Windows para as cores das janelas nas configurações gerais.

[Link].1.2 Color
Retorna a cor do texto de um Campo de um E3Browser. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).

[Link].1.3 Format
Configura o formatador usado na coluna de um Campo de um E3Browser.

[Link].1.4 Name
Retorna o nome de um Campo de um E3Browser.

[Link].1.5 Visible
Habilita ou desabilita a visibilidade do Campo selecionado na Consulta de um E3Browser. Se esta propriedade está
configurada para Verdadeiro, o Campo é visível em um E3Browser. Caso contrário, o Campo não é mostrado em um
E3Browser, em tempo de execução. O valor padrão desta propriedade é Verdadeiro.

[Link].1.6 Width
Retorna a largura de um Campo de um E3Browser, em pixels.

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.

[Link] OnCursorChange
OnCursorChange()
Ocorre quando o cursor do E3Chart muda de posição. Por exemplo, pode-se criar um script para este evento quando
é necessário mostrar os valores de posição do cursor na Tela. O script a seguir contém um exemplo de uso deste
evento.
Sub E3Chart1_OnCursorChange()
Set Chart = [Link]("").[Link]("E3Chart1")
Set Pena = [Link](0)
' O objeto Text1 deve mostrar a posição atual do cursor
Set Texto = [Link]("").[Link]("Text1")
If [Link](aa, bb) Then
[Link] = "Posição X = " & aa & "; Posição Y = " & bb
End If
End Sub

200 Visualização
[Link] 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. O script a seguir
contém um exemplo de uso deste evento.
Sub E3Chart1_OnLegendClick(Row, Col, RowData)
Set texto = [Link]("Texto1")
[Link] = [Link](col).Name & " " & _
[Link](RowData).Name
End Sub

[Link] OnQueryFinish
OnQueryFinish()
Ocorre quando uma ou mais Consultas são encerradas no E3Chart. Quando o evento é 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.

[Link] ClearPenMarks
ClearPenMarks()
Remove as marcas de pesquisa de todas as Penas do E3Chart.

[Link] CopyConfig
CopyConfig(SourceChart, [Flags])
Este método 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 este método.

NOTA
No caso dos Relatórios de Seção, este método funciona somente com Penas do tipo 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 de Seção (ReportChart), o seguinte script pode ser adicionado no objeto Report associado
ao Relatório de Seção.
Sub OnBeforePrint
Set Chart = _
[Link]("PageHeader").Controls("ReportChart")
[Link]([Link]()._
[Link]("ScreenChart"))
[Link]()
[Link]()
End Sub

NOTA
Este método também possui o parâmetro opcional e não usado Flags, somente para fins de compatibilidade com
versões anteriores.

[Link] FitAll
FitAll([FitStyle])
Enquadra todas as Penas no E3Chart. O parâmetro opcional FitStyle indica o modo de enquadramento das Penas em
tempo de execução e, se omitido, assume o valor 0 (zero). Os valores possíveis são 0: Enquadra ambos os Eixos ao
mesmo tempo, 1: Enquadra apenas o Eixo Vertical ou 2: Enquadra apenas o Eixo Horizontal.

Visualização 201
[Link] FitPen
FitPen(Pen, [FitStyle])
Enquadra uma Pena no E3Chart. 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 e, se
omitido, assume o valor 0 (zero). Os valores possíveis são 0: Enquadra ambos os Eixos ao mesmo tempo, 1: Enquadra
apenas o Eixo Vertical ou 2: Enquadra apenas o Eixo Horizontal. O script a seguir contém um exemplo de uso deste
método.
Sub CommandButton1_Click()
Set Chart = [Link]("E3Chart1")
[Link](1)
[Link]("Pen1", 1)
' Enquadra a Pen1 somente na vertical
End Sub

[Link] 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 de Seção.

NOTA
Este método é síncrono somente se a Pena não estiver em modo Consulta Automática.

[Link] ResetConfig
ResetConfig([Flags])
Remove todas as configurações ajustadas em um E3Chart, devolvendo-o ao estado inicial.

NOTA
Este método também possui o parâmetro opcional e não usado Flags, somente para fins de compatibilidade com
versões anteriores.

[Link] 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 E3Chart e selecionando a opção Pesquisar Intervalos do menu contextual.

[Link] ZoomIn
ZoomIn()
Este método 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.

[Link] ZoomOut
ZoomOut()
Este método 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.

[Link] Axes
Retorna a coleção de Eixos do E3Chart. A partir daí, as propriedades da coleção de Eixos podem ser modificadas.
Esta propriedade é somente de leitura.

202 Visualização
[Link] 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)).

[Link] 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 cursores apareçam.

[Link] CursorColor
Estabelece a cor do cursor de pesquisa de intervalo. O valor padrão é vermelho (RGB(255, 0, 0)).

[Link] 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.

[Link] 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 a propriedade CursorLineStyle
OPÇÃO DESCRIÇÃO
0 - LS_Solid Aplica uma linha sólida no cursor de intervalo do E3Chart
(padrão)

1 - LS_Dash Aplica uma linha tracejada no cursor de intervalo do

E3Chart

2 - LS_Dot Aplica uma linha pontilhada no cursor de intervalo do

E3Chart

3 - LS_Dashdot Aplica uma linha traço e ponto no cursor de intervalo do

E3Chart

4 - LS_Dashdotdot Aplica uma linha traço ponto ponto no cursor de

intervalo do E3Chart

5 - LS_Null Aplica uma linha invisível no cursor de intervalo do

E3Chart

[Link] CursorLineWidth
Estabelece a largura do cursor de intervalo.

[Link] CursorSearchStyle
Permite que o cursor pesquise os pontos do gráfico. Os valores possíveis são 0 - PointNearest: Pesquisa o ponto
mais próximo (padrão), 1 - LinearInterpolation: Pesquisa um ponto interpolado ou 2 - PointPrevious: Pesquisa o
ponto anterior.

[Link] ForeColor
Determina a cor de frente do E3Chart. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).

[Link] GridBkColor
Determina a cor de fundo da grade do E3Chart. O valor padrão desta propriedade é branco (RGB(255, 255, 255)).
O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set E3Chart1 = [Link]("E3Chart1")
Old = [Link]
MsgBox "Próxima"
[Link] = RGB(0, 255, 0)
MsgBox "Voltar"
[Link] = Old
End Sub

Visualização 203
[Link] HorAxisTitle
Determina o título do Eixo Horizontal principal. O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set E3Chart1= [Link]("E3Chart1")
Old = [Link]
MsgBox "Próxima"
[Link] = "!Teste"
MsgBox "Voltar"
[Link] = Old
End Sub

[Link] 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 a propriedade HorGrid
OPÇÃO DESCRIÇÃO
0 - Solid Aplica uma linha sólida na grade horizontal do E3Chart

1 - Dash Aplica uma linha tracejada na grade horizontal do

E3Chart

2 - Dot Aplica uma linha pontilhada na grade horizontal do

E3Chart (padrão)

3 - Dashdot Aplica uma linha traço e ponto na grade horizontal do

E3Chart

4 - Dashdotdot Aplica uma linha traço ponto ponto na grade horizontal

do E3Chart

5 - Invisible Aplica uma linha invisível na grade horizontal do E3Chart

O script a seguir contém um exemplo de uso desta propriedade.

Sub CommandButton1_Click()
Set E3Chart1 = [Link]("E3Chart1")
Old = [Link]
For i = 0 To 5
[Link] = i
MsgBox "[Link] =" & CStr(i)
Next
MsgBox "Voltar"
[Link] = Old
End Sub

[Link] HorGridColor
Determina a cor da grade horizontal do objeto E3Chart. O valor padrão desta propriedade é cinza (RGB(192, 192,
192)). O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set E3Chart1 = [Link]("E3Chart1")
Old = [Link]
MsgBox "Próxima"
[Link] = RGB(255, 0, 0)
MsgBox "Próxima"
[Link] = RGB(0, 0, 255)
MsgBox "Voltar"
[Link] = Old
End Sub

[Link] HorMinorTicks
Determina o número de subdivisões das escalas horizontais da grade. O valor padrão desta propriedade é 1 (um).
O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set E3Chart1 = [Link]("E3Chart1")
Old = [Link]
For i = 0 To 5

204 Visualização
 [Link] = i
MsgBox "Próximo valor"
Next
[Link] = Old
End Sub

[Link] 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.

[Link] 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. O script a seguir contém um exemplo de uso desta propriedade.
Sub ComboBox1_Change()
' Define qual consulta deseja mostrar
current_query_index = ListIndex
Set E3Chart1 = [Link]("E3Chart1")
i = 0
For Each query In [Link]
If i = current_query_index Then
[Link](0) = "" ' Traz tudo
Set current_query = query
Else
[Link](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 [Link]
[Link] = ([Link] = current_query.Name)
Next
' Atualiza as consultas
[Link]()
[Link]("E3Chart1").HorScaleBegin = Now - 0.001
[Link]("E3Chart1").HorScaleEnd = Now
End Sub

[Link] 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 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

A máscara destes formatos, como exemplificadas no campo Tipo, é exibida na Janela de Propriedades, como por
exemplo d/M/yy H:mm, 0E-00.

Visualização 205
[Link] 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. O script a seguir contém um exemplo de uso desta propriedade.
Sub SubCommandButton1_Click()
Set E3Chart1 = [Link]("E3Chart1")
Old = [Link]
For i = 0 To 30 Step 10
[Link] = i
MsgBox "[Link] = " & CStr(i)
Next
MsgBox "Voltar"
[Link] = Old
End Sub

[Link] Legend
Retorna o objeto Legenda do E3Chart. A partir daí, as propriedades da Legenda podem ser modificadas. Esta
propriedade é somente de leitura.

[Link] 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:
· 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 (padrão)
· 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

[Link] Padding
Esta propriedade determina a distância, em pixels, entre o gráfico e a borda do E3Chart, conforme pode ser
observado nas figuras seguintes através das setas vermelhas. O valor padrão desta propriedade é 10.

206 Visualização
 Propriedade Padding igual a 10

Propriedade Padding igual a 30

Visualização 207
[Link] 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. O script a seguir contém um exemplo
de uso desta propriedade.
Sub CommandButton1_Click()
For Each pen In [Link]("E3Chart1").Pens
[Link] = True
Next
End Sub

[Link] 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.

[Link] RefreshTime
Esta propriedade determina o tempo de atualização do E3Chart.

[Link] RenderQuality
Controla a qualidade de desenho das Penas do E3Chart. Os valores possíveis para esta propriedade são os
seguintes:
· 0 - rqDefault: Utiliza o modo de qualidade configurado na propriedade RenderQuality da Tela, se diferente de 0
(zero), ou o modo de qualidade configurado na propriedade RenderQuality do Viewer, também se diferente de
0 (zero), nesta ordem. Do contrário, utiliza o modo de qualidade normal (GDI, Graphics Device Interface). Este é o
valor padrão para aplicações criadas em versões anteriores à 4.8
· 1 - rqNormal: Força o modo de qualidade normal (GDI) para o desenho das Penas
· 2 - rqHighQuality: Força o modo de alta qualidade (GDI+) para o desenho das Penas. Este é o valor padrão para
aplicações criadas a partir da versão 4.8

[Link] ScaleFont
Determina a fonte do texto utilizada na grade. Consulte o tópico Fonte para mais informações sobre as
subpropriedades desta propriedade.

[Link] ShowBackground
Habilita ou desabilita a visualização do fundo do gráfico. Se a propriedade é 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). O script a seguir contém um exemplo
de uso desta propriedade.
Sub CommandButton1_Click()
Set E3Chart1 = [Link]("E3Chart1")
[Link] = Not [Link]
End Sub

[Link] ShowBorder
Habilita ou desabilita uma borda externa no E3Chart, quando a visualização das escalas (propriedades
ShowBottomScale, ShowLeftScale, ShowRightScale e ShowTopScale) está desabilitada. O valor padrão desta
propriedade é Verdadeiro.

[Link] 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. O script a seguir contém um exemplo de uso desta
propriedade.
Sub CommandButton1_Click()
Set E3Chart1 = [Link]("E3Chart1")
oldBottomScale = [Link]
MsgBox "Mostrar eixo"
[Link] = True
MsgBox "Esconder eixo"
[Link] = False
MsgBox "Voltar..."
208 Visualização
 [Link] = oldBottomScale
End Sub

[Link] ShowGridBackground
Habilita ou desabilita a visualização do fundo da grade. Se a propriedade é 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. O script a seguir contém um exemplo de uso desta
propriedade.
Sub CommandButton1_Click()
Set Chart1 = [Link]("E3Chart1")
[Link] = Not [Link]
End Sub

[Link] ShowLeftScale
Se a propriedade estiver configurada para Verdadeiro, o Eixo Vertical principal é mostrado à esquerda da grade.
Caso contrário, permanece invisível. O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set Chart = [Link]("E3Chart1")
[Link] = Not [Link]
End Sub

[Link] ShowPopupMenu
Habilita ou desabilita a opção de mostrar o menu em tempo de execução do E3Chart. Se o valor é 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 é igual a Falso, o menu não é mostrado. O valor padrão desta propriedade é Verdadeiro.

[Link] ShowRightScale
Se a propriedade estiver configurada para Verdadeiro, o Eixo Vertical principal da escala é mostrado à direita da
grade. Caso contrário, permanece invisível. O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set Chart = [Link]("E3Chart1")
[Link] = Not [Link]
End Sub

[Link] 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. O script a seguir contém um
exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set E3Chart1 = [Link]("E3Chart1")
oldTitle = [Link]
oldShowTitle = [Link]
[Link] = "Teste!"
MsgBox "Mostrar"
[Link] = True
MsgBox "Esconder"
[Link] = False
MsgBox "Voltar"
[Link] = oldTitle
[Link] = oldShowTitle
End Sub

[Link] 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. O script a seguir contém um exemplo de uso desta
propriedade.
Sub CommandButton1_Click()
Set Chart = [Link]("E3Chart1")
[Link] = Not [Link]
End Sub

Visualização 209
[Link] TimeSpan
Indica a escala de tempo que aparece no Eixo Horizontal principal do E3Chart, quando este é configurado para
mostrar a escala de tempo real. O valor desta propriedade é sempre em segundos. O valor padrão desta
propriedade é 60.

[Link] 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.

[Link] TitleColor
Determina a cor do texto do título do E3Chart.

[Link] TitleFont
Determina a fonte do título principal do E3Chart. Consulte o tópico Fonte para mais informações sobre as
subpropriedades desta propriedade.

[Link] VerAxisTitle
Determina o título do Eixo Vertical principal.

[Link] 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 a propriedade VerGrid
OPÇÃO DESCRIÇÃO
0 - Solid Aplica uma linha sólida na grade vertical do E3Chart

1 - Dash Aplica uma linha tracejada na grade vertical do E3Chart

2 - Dot Aplica uma linha pontilhada na grade vertical do E3Chart

(padrão)

3 - Dashdot Aplica uma linha traço e ponto na grade vertical do

E3Chart

4 - Dashdotdot Aplica uma linha traço ponto ponto na grade vertical do

E3Chart

5 - Invisible Aplica uma linha invisível na grade vertical do E3Chart

[Link] VerGridColor
Determina a cor da linha do Eixo Vertical principal da grade. O valor padrão desta propriedade é cinza (RGB(192,
192, 192)).

[Link] 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).

[Link] VerScaleBegin
Determina o valor no topo no Eixo Vertical principal da grade do E3Chart. O valor padrão desta propriedade é 100.

[Link] VerScaleEnd
Determina o valor na base do Eixo Vertical principal da grade. O valor padrão desta propriedade é -100.

[Link] 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:

210 Visualização
 · 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 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

A máscara destes formatos, como exemplificado no campo Tipo, é exibida na Janela de Propriedades, como por
exemplo d/M/yy H:mm, 0E-00.

[Link] 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. O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set E3Chart1 = [Link]("E3Chart1")
Old = [Link]
For i = 0 To 30 Step 10
[Link] = i
MsgBox "[Link] = " & CStr(i)
Next
MsgBox "Voltar"
[Link] = Old
End Sub

4.6.4 Coleção de Consultas

Esta seção contém informações sobre métodos e propriedades do objeto Coleção de Consultas
(DispQueryCollection). Este objeto não possui eventos associados.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Consultas (DispQueryCollection).

[Link].1 AddQuery
AddQuery(QueryName, [Unused])
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 Unused, que é opcional, obsoleto e não deve ser
informado. Consulte a propriedade geral Name para mais informações sobre os caracteres permitidos nos nomes de
objetos.

[Link].2 Item
Item(Index)
Este método 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).

[Link].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 211
[Link].4 UpdateData
UpdateData()
Atualiza os dados de todas as Consultas. O script a seguir contém um exemplo de uso deste método.
Sub Texto1_Click()
Set E3Chart1 = [Link]("E3Chart1")
[Link]()
End Sub

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Consultas (DispQueryCollection).

[Link].1 Count
Contém o número de Consultas do E3Chart. Esta propriedade é somente de leitura.

4.6.5 Coleção de Eixos

Esta seção contém informações sobre métodos e propriedades do objeto Coleção de Eixos (AxisCollection). Este
objeto não possui eventos associados.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Eixos (AxisCollection).

[Link].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. Consulte a propriedade geral Name para mais
informações sobre os caracteres permitidos nos nomes de objetos.

[Link].2 Item
Item(Index)
Retorna um Eixo através de seu nome ou índice, indicado pelo parâmetro Index. O índice 0 (zero) é sempre o Eixo
Horizontal principal, o índice 1 (um) é sempre o Eixo Vertical principal e o índice 2 (dois) é sempre o Eixo Automático
principal.

[Link].3 Remove
Remove(Index)
Remove o Eixo através de seu nome ou índice, conforme especificado no parâmetro Index. Os Eixos 0 (zero, Eixo
Horizontal), 1 (um, Eixo Vertical) e 2 (dois, Eixo Automático) não podem ser removidos. Caso se tente removê-los, uma
mensagem de erro é exibida.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Eixos (AxisCollection).

[Link].1 AutoAxis
Retorna o Eixo Automático principal. Este Eixo também participa da lista de Eixos. Esta propriedade é somente de
leitura.

[Link].2 Count
Retorna o número de Eixos do E3Chart, incluindo os Eixos principais (Horizontal, Vertical e Automático). Esta
propriedade é somente de leitura.

212 Visualização
[Link].3 HorAxis
Retorna o Eixo Horizontal principal. Este Eixo também participa da lista de Eixos. Esta propriedade é somente de
leitura.

[Link].4 VerAxis
Retorna o Eixo Vertical principal. Este Eixo também participa da lista de Eixos. Esta propriedade é somente de
leitura.

[Link] Eixo
Esta seção contém informações sobre métodos e propriedades do objeto Eixo (Axis). Este objeto não possui eventos
associados.

[Link].1 Métodos
Esta seção contém informações sobre os métodos do objeto Eixo (Axis).

NOTA
As propriedades AutoAxis, HorAxis e VerAxis são propriedades da Coleção de Eixos que acessam os Eixos padrão
Automático, Horizontal e Vertical, respectivamente. Por exemplo, ao invés de utilizar
"[Link]('EixoHorizontal')", pode-se utilizar "[Link]". Os demais Eixos criados pelo usuário devem
ser acessados por seus nomes usando o método Item.

[Link].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.

[Link].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.

[Link].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 Unidade de tempo em segundos

1 - tuMinutes Unidade de tempo em minutos

2 - tuHours Unidade de tempo em horas

3 - tuDays Unidade de tempo em dias

4 - tuWeeks Unidade de tempo em semanas

5 - tuMonths Unidade de tempo em meses

6 - tuYears Unidade de tempo em anos

[Link].1.4 GetTickSpacing
GetTickSpacing(TickSpacing)
Retorna a unidade de tempo configurada para o espaçamento entre as divisões da escala (ticks) indicado pelo
parâmetro TickSpacing. Os valores retornados por este método estão descritos no método GetRealTimePeriod.

Visualização 213
[Link].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.

[Link].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.

[Link].1.7 SetRealTimePeriod
SetRealTimePeriod(Times, TimeUnit)
Ajusta o intervalo de tempo definido no parâmetro Times na unidade da escala definida pelo parâmetro TimeUnit. As
opções disponíveis para o parâmetro TimeUnit estão descritas no método GetRealTimePeriod. O Eixo permanece
sendo atualizado sempre neste modo (tempo real).

[Link].1.8 SetTickSpacing
SetTickSpacing(TickSpacing, TimeUnit)
Configura o espaçamento entre as divisões da escala (ticks) determinado pelo parâmetro TickSpacing usando a
unidade de tempo indicada pelo parâmetro TimeUnit. Caso a escala seja numérica, a unidade de tempo não é
considerada. As opções disponíveis para o parâmetro TimeUnit estão descritas no método GetRealTimePeriod.

[Link].2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Eixo (Axis).

NOTA
As propriedades AutoAxis, HorAxis e VerAxis são propriedades da Coleção de Eixos que acessam os Eixos padrão
Automático, Horizontal e Vertical, respectivamente. Por exemplo, ao invés de utilizar
"[Link]('EixoHorizontal')", pode-se utilizar "[Link]". Os demais Eixos criados pelo usuário devem
ser acessados por seus nomes usando o método Item.

[Link].2.1 Color
Determina a cor principal do Eixo.

[Link].2.2 EnableScaleColor
Esta propriedade, quando habilitada, especifica que a escala é desenhada com a mesma cor da Pena selecionada.
Esta propriedade só está disponível para Eixos criados automaticamente para Penas do tipo Automática e seu valor
padrão é Verdadeiro.

[Link].2.3 EnableTextColor
Esta propriedade, quando habilitada, especifica que o texto do Eixo tem a mesma cor da escala configurada na
propriedade Color. Se desabilitada, o texto do Eixo tem a mesma cor configurada na propriedade ForeColor do
E3Chart. O valor padrão desta propriedade é Falso.

[Link].2.4 Format
Determina a formatação dos valores do Eixo. Os formatos permitidos nesta propriedade estão descritos no Manual
do Usuário do Elipse E3, no tópico Telas e Objetos de Tela - Formatação de Valores, ou em branco para selecionar
o modo Automático. Esta propriedade permite utilizar o caractere de barra vertical (|) na String de formatação como
uma quebra de linha.
Se a formatação do Eixo é selecionada como Automática (Janela de Propriedades do Eixo, aba Escala, grupo
Formatação) e o tipo de escala é selecionado como Mostrar último período (tempo real) ou Intervalo de tempo
(histórico), o formato de data e hora obedece a configuração regional do usuário do Windows. Se o tipo de escala é
selecionado como Escala numérica, utiliza-se a formatação automática de números.

214 Visualização
[Link].2.5 GridColor
Determina a cor das linhas da grade. O valor padrão desta propriedade é prata (RGB(192, 192, 192)).

[Link].2.6 GridStyle
Determina o estilo da linha da grade. As opções disponíveis estão descritas na tabela a seguir.
Opções disponíveis para a propriedade GridStyle
OPÇÃO DESCRIÇÃO
0 - solid O estilo da linha da grade é sólida

1 - dash O estilo da linha da grade é pontilhada

2 - dot O estilo da linha da grade é tracejada (padrão)

3 - dashdot O estilo da linha da grade é pontilhada e tracejada

4 - dashdotdot O estilo da linha da grade é traço-ponto-ponto

5 - invisible Não há linhas visíveis na grade (invisível)

[Link].2.7 Inverse
Inverte a ordem dos valores mínimo e máximo na escala numérica. Normalmente, em escalas verticais, o valor
mínimo aparece abaixo e o valor máximo acima. Nas escalas horizontais, o valor mínimo aparece na esquerda e o
valor máximo na direita. Quando esta propriedade está configurada para Verdadeiro, no entanto, esta ordem é
invertida, valores máximos abaixo ou à esquerda e valores mínimos acima ou à direita.

[Link].2.8 MinorTicks
Determina o número total de subdivisões entre as escalas.

[Link].2.9 Mirror
Indica o espelhamento do Eixo. Se a propriedade estiver configurada para Verdadeiro, o Eixo é espelhado no lado
oposto do Eixo original. Caso contrário, o Eixo permanece na mesma posição.

[Link].2.10 Name
Determina o nome do Eixo. Consulte a propriedade geral Name para mais informações sobre os caracteres
permitidos no nome deste objeto.

[Link].2.11 NormalBandColor
Determina a cor da banda de referência. O valor padrão desta propriedade é cinza (RGB(128, 128, 128)).

[Link].2.12 NormalBandHighValue
Determina o valor superior da banda de referência.

[Link].2.13 NormalBandLowValue
Determina o valor inferior da banda de referência.

[Link].2.14 NormalBandVisible
Determina a visibilidade da banda de referência. O valor padrão desta propriedade é Falso, ou seja, a banda de
referência não é visível.

[Link].2.15 Position
Determina a posição do Eixo em relação à grade do E3Chart. As opções disponíveis estão descritas na tabela a
seguir.
Opções disponíveis para a propriedade Position
OPÇÃO DESCRIÇÃO
0 - axpLeft O Eixo é posicionado à esquerda da escala

Visualização 215
 OPÇÃO DESCRIÇÃO
1 - axpRight O Eixo é posicionado à direita da escala (padrão)

2 - axpTop O Eixo é posicionado no topo da escala

3 - axpBottom O Eixo é posicionado na base da escala

[Link].2.16 ReferenceLineColor
Determina a cor da linha de referência. O valor padrão desta propriedade é cinza (RGB(128, 128, 128)).

[Link].2.17 ReferenceLineStyle
Determina o estilo da linha de referência. Os valores possíveis para esta propriedade são 0: Sólida, 1: Tracejada, 2:
Pontilhada, 3: Traço-Ponto ou 4: Traço-Ponto-Ponto. O valor padrão desta propriedade é 0: Sólida.

[Link].2.18 ReferenceLineValue
Determina o valor usado como referência para a linha.

[Link].2.19 ReferenceLineVisible
Determina a visibilidade da linha de referência. O valor padrão desta propriedade é Falso, ou seja, a linha de
referência não é visível.

[Link].2.20 ReferenceLineWidth
Determina a espessura da linha de referência. O valor padrão desta propriedade é 1 (um) pixel.

[Link].2.21 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 a propriedade ScaleType
OPÇÃO DESCRIÇÃO
0 - atNumberScale Escala numérica (padrão)

1 - atLastPeriod Mostra último período (Tempo Real)

2 - atPeriod Intervalo de tempo (Histórica)

[Link].2.22 ShowGrid
Determina se as linhas da grade são visíveis ou não. Se a propriedade estiver configurada para Verdadeiro, as
linhas da grade são mostradas. Caso contrário, as linhas são escondidas.

[Link].2.23 Title
Determina o título do Eixo.

[Link].2.24 UsePenEUAsTitle
Esta propriedade, quando habilitada, copia a unidade de engenharia da Pena selecionada e a utiliza como título do
Eixo, sobrescrevendo a propriedade Title. Esta propriedade só está disponível para Eixos criados automaticamente
para Penas do tipo Automática e seu valor padrão é Verdadeiro.

[Link].2.25 Visible
Determina a visibilidade do Eixo na grade. Se a propriedade estiver configurada para Verdadeiro, o Eixo é visível na
grade. Caso contrário, o Eixo permanece invisível.

4.6.6 Coleção de Penas

Esta seção contém informações sobre métodos e propriedades do objeto Coleção de Penas (DispPenCollection). Este
objeto não possui eventos associados.

216 Visualização
[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Penas (DispPenCollection).

NOTA
A Coleção de Penas do E3Chart deve ser acessada através da propriedade Pens.

[Link].1 AddPen
AddPen(PenName)
Este método adiciona uma nova Pena ao E3Chart, retornando a Pena criada. Consulte a propriedade geral Name para
mais informações sobre os caracteres permitidos nos nomes de objetos. O script a seguir contém um exemplo de uso
deste método.
Sub CommandButton1_Click()
' Cria uma pena sem nome.
Set Pen = [Link]("E3Chart1").[Link]("")
MsgBox [Link]
End Sub

SubCommandButton1_DblClick()
' Cria uma pena com o nome "Pen1".
' Se o nome existir, a pena é incrementada.

Set Pen = [Link]("E3Chart1").[Link]("Pen1")

MsgBox [Link]
End Sub

Sub CommandButton2_Click()
' Cria uma pena e associa a TagDemo1.
Set Chart = [Link]("E3Chart1")
Set Pen = [Link]("")
MsgBox [Link]
[Link] = True
[Link] = "Dados.TagDemo1"
[Link]()
End Sub

[Link].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 é desenhada depois da Pena de linha, aquela pode esconder esta última.
A solução então seria inverter a ordem de desenho destas Penas. O script a seguir contém um exemplo de uso deste
método.
Sub CommandButton1_Click()
' Move a Pena 1 para a posição 2.
[Link]("E3Chart1").[Link](1, 2)
End Sub

[Link].3 Item
Item(Index)
Este método retorna um objeto Pena desta 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. O script a seguir contém um exemplo de uso deste método.
Sub CommandButton1_Click()
' Obtém a primeira Pena.
Set Pen1 = [Link]("E3Chart1").[Link](0)
End Sub

Visualização 217
[Link].4 Remove
Remove(Index)
Remove uma Pena desta 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.

[Link].5 SetCursorPos
SetCursorPos(X, [Range])
Posiciona o cursor de cada Pena do E3Chart. Equivale a utilizar o método SetCursorPos de cada uma das Penas desta
Coleção.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Penas (DispPenCollection).

[Link].1 Count
Contém o número de Penas inseridas no E3Chart. Esta propriedade é somente de leitura.

[Link] Pena
Esta seção contém informações sobre métodos e propriedades do objeto Pena (DispChartPen). Este objeto não
possui eventos associados.

[Link].1 Métodos
Esta seção contém informações sobre os métodos do objeto Pena (DispChartPen).

[Link].1.1 AddPoint
AddPoint(ValueX, ValueY, [Quality])
Adiciona um ponto ao final do buffer de tempo real. O tamanho do buffer só é válido após a conexão da Pena. Se a
Pena é criada no Elipse E3 Studio a conexão é automática, mas se é criada via script é necessário utilizar o método
Connect após sua criação. Este método deve ser usado com Penas do tipo Tempo Real, e com a propriedade
UseTimeStamp em Falso. O parâmetro opcional Quality indica a qualidade do ponto a ser inserido. Se este
parâmetro não é informado, a qualidade do ponto é considerada boa (192). O número de pontos que podem ser
adicionados a uma Pena está relacionado ao tamanho do buffer (propriedade BufferSize da Pena).

[Link].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
remove dados históricos.

NOTA
Este método não tem efeito em Penas do tipo Automática.

[Link].1.3 Connect
Connect()
Este método conecta a Pena ao servidor para receber os dados de tempo real, associando as propriedades XLink e
YLink. Se a Pena já está conectada, este método permanece inativo. O script a seguir contém um exemplo de uso
deste método.
Sub CommandButton1_Click()
Set Pen1 = [Link]("E3Chart1").[Link]("Pen1")
[Link]()
[Link]()
End Sub

218 Visualização
[Link].1.4 Disconnect

Disconnect()
Este método limpa os dados atuais e permite que a Pena não receba mais os dados de tempo real do seu Tag
associado. Se a Pena já está desconectada, este método permanece inativo. Quando este método é usado em uma
Pena do tipo Histórica e Tempo Real (propriedade DataSourceType igual a 2), remove-se 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. O script a seguir contém um exemplo de uso deste método.
Sub CommandButton1_Click()
Set Pen1 = [Link]("E3Chart1").[Link]("Pen1")
[Link]()
[Link]()
End Sub

[Link].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 este método é bem-sucedido retorna Verdadeiro, caso contrário
retorna Falso. O script a seguir contém um exemplo de uso deste método.
Sub CommandButton1_Click()
For Each pen In [Link]
If [Link](aa, bb) Then
strResult = strResult & pen.Name_
& " := " & CSTr(CDate(aa)) + _
"y " + CStr(bb) + vbNewLine
End If
Next
MsgBox strResult
End Sub

[Link].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. Este
método retorna Verdadeiro se encontrou um ponto, e Falso caso contrário.

[Link].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. Se omitido, seu valor é igual a -1.0 (menos
um). 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. O script a seguir contém um exemplo de uso deste método.
' 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)

' Quando range é usado, o cursor só é movido

' se ponto estiver dentro do range.
' Não vai mover o cursor, porque 2 está mais de 0.5 unidade
' distante do ponto mais próximo, que é 1.
SetCursorPos(2, 0.5)
' Envia o cursor para o ponto (1, 10).
SetCursorPos(2, 4)

Este método retorna Verdadeiro se o cursor foi movido, caso contrário retorna Falso.

[Link].2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Pena (DispChartPen).

Visualização 219
[Link].2.1 AutoQuery
Quando esta propriedade está configurada para Verdadeiro, diz-se que a Pena é do tipo Consulta Automática. O
objetivo deste tipo de Pena é diminuir o consumo de memória e o tempo de consulta. Para isto, a Pena aplica filtros
no campo E3Timestamp para trazer somente os dados necessários para dentro da área do E3Chart. Toda vez que o
período visível do E3Chart é alterado, a Pena de Consulta Automática traz os dados que estão faltando para
completar o desenho daquele período. Além disto, a Pena de Consulta Automática também completa os dados
históricos que estão faltando para conectar as partes histórica e de tempo real da Pena. Se por acaso os dados
históricos não chegarem após trinta segundos, a Consulta Automática é cancelada naquele trecho. Consulte também a
propriedade MaxGapTime para maiores detalhes.
Devido ao modo como a Consulta Automática aplica filtros para o campo E3Timestamp, este tipo de Pena não está
disponível para consultas de Storage e código SQL personalizados pelo usuário, ou seja, mesmo que esta
propriedade esteja configurada para Verdadeiro, esta propriedade não tem efeito se a Consulta é do tipo Storage.
Uma das formas de reconhecer a Consulta Automática é o desenho hachurado na tela do E3Chart. Toda vez que
aparecem hachuras no desenho, significa que naquele período está ocorrendo uma Consulta Automática. Quando o
contorno da parte hachurada estiver na cor vermelha, significa que a Consulta Automática daquele trecho está
falhando. Neste caso, o E3Chart refaz a Consulta do trecho com problemas.

NOTA
Diferentemente da parte de tempo real, onde cada Pena possui seu próprio buffer de dados, a parte histórica da
Pena é armazenada na Consulta e é compartilhada entre as Penas. Por exemplo, quando uma Consulta tem os
campos E3Timestamp, Campo1 e Campo2, estes dados permanecem armazenados na Consulta e estão à
disposição para as Penas que compartilham aquela Consulta. Com isto, a parte comum, geralmente o campo
E3Timestamp, pode ser usada por duas Penas diferentes sem que os dados sejam duplicados. No caso das Penas
de Consultas Automáticas, duas Penas diferentes podem usar a mesma tabela e, devido a escalas diferentes, podem
carregar períodos diferentes da Consulta. Nesta situação, cada Pena herda automaticamente a parte carregada pela
outra Pena.
O objeto Consulta não pode funcionar simultaneamente em modo Automático e Não Automático. Isto significa
também que se Penas diferentes, uma do tipo Consulta Automática e outra do tipo Consulta Não Automática,
queiram compartilhar a mesma Consulta, esta Consulta vai se adaptar à primeira Pena que utilizá-la, ou seja, esta
propriedade não garante que a Consulta é do tipo Automático, dependendo também de outros fatores.

[Link].2.2 AverageY
Informa a média da Pena no intervalo, caso a propriedade EnableCalc esteja habilitada. Caso o E3Chart esteja no
modo de Pesquisa de Intervalos, mostra a média neste intervalo. Do contrário, mostra a média no intervalo entre o
início e o fim no Eixo Horizontal. Valores com qualidade ruim não são considerados caso a propriedade
ShowBadPoints esteja desabilitada. Esta propriedade é somente de leitura.

[Link].2.3 BkColor
Determina a cor de fundo usada em uma Pena cuja propriedade PenType seja igual a 3 (três, Área). O valor padrão
desta propriedade é branco (RGB(255, 255, 255)).

[Link].2.4 BufferSize
Determina o número de pontos mantidos em uma Pena do tipo Tempo Real. Após este valor, os dados mais
antigos são descartados. 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). O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set Pen1 = [Link]("E3Chart1").[Link]("Pen1")
[Link]()
[Link] = 5000
[Link]()
End Sub

[Link].2.5 Color
Determina a cor da linha da Pena no E3Chart. O valor padrão desta propriedade é vazio.

220 Visualização
[Link].2.6 DataSourceType
Determina a origem dos dados de uma Pena. As opções disponíveis para esta propriedade estão descritas na
tabela a seguir.
Opções disponíveis para a propriedade DataSourceType
OPÇÃO DESCRIÇÃO
0 - Tempo Real Indica uma conexão desta Pena a um Tag atualizado em
tempo real

1 - Histórica Indica uma conexão desta Pena aos dados recebidos de

uma Consulta

2 - Histórica e Tempo Real Indica uma conexão desta Pena a Tags de tempo real e
dados históricos simultaneamente

3 - Automática Indica uma conexão automática desta Pena a um

servidor, conforme um período de tempo selecionado no
Eixo Horizontal

Quando esta propriedade é igual a 0 (zero, Tempo Real), as propriedades XLink e YLink informam os links utilizados,
ou então a propriedade UseTimeStamp informa que a propriedade XLink não é usada, estando em seu lugar a
estampa de tempo da propriedade YLink. Quando esta propriedade é igual a 1 (um, Histórica), as propriedades
XField e YField informam os campos da tabela a serem usados. A propriedade QueryName indica o nome da tabela
usada. Quando esta propriedade é igual a 2 (dois, Histórica e Tempo Real), as opções 0 (zero) e 1 (um) funcionam
simultaneamente para a Pena. Quando esta propriedade é igual a 3 (três, Automática), a Pena é plotada utilizando um
Eixo automático, que recebe os limites mínimos e máximos a partir das configurações da unidade de engenharia do
Tag no servidor.

NOTA
Em tempo de execução, quando esta propriedade é alterada e a Pena deixar de mostrar os dados de tempo real, é
preciso utilizar o método Connect para que estes dados sejam mostrados novamente.

O script a seguir contém um exemplo de uso desta propriedade.

Sub CommandButton1_Click()
Set E3Chart1 = [Link]("E3Chart1")
MsgBox "Clique em OK para criar a Pena."
Set Pen = [Link]("Pen1")
[Link] = 0 ' Tempo real
[Link] = "Dados.TagDemo1"
[Link] = True ' Em X usa a estampa de tempo
[Link] = RGB(255, 0, 0)
[Link] = "Teste"
MsgBox "Clique em OK para conectar."
[Link]() ' Começa a receber os dados
MsgBox "Clique em OK para enquadrar."
[Link](0)
MsgBox "Clique em OK para remover a Pena."
[Link]([Link])
End Sub

[Link].2.7 DigitalData
Determina o estilo de plotagem digital. Se esta propriedade está configurada em Verdadeiro, o estilo de plotagem
digital assume que a variação do dado seja de forma digital, ou seja, que seu valor em relação ao último variou
instantaneamente. Caso contrário, a variação é considerada linear e os pontos são unidos por um segmento de reta.
O valor padrão desta propriedade é Verdadeiro. Esta propriedade não tem efeito se a propriedade
EnableAutoPlotMode está configurada em Verdadeiro.

[Link].2.8 EnableAutoPlotMode
Habilita o modo automático de ligação dos pontos de uma Pena do tipo Automática. O valor padrão desta
propriedade é Verdadeiro. Ao configurar esta propriedade em Verdadeiro, a propriedade DigitalData não é utilizada
na ligação dos pontos. Se houver necessidade de sobrescrever a forma de ligação dos pontos de uma Pena

Visualização 221
recebidos de um servidor, pode-se configurar esta propriedade em Falso e configurar a propriedade DigitalData
para a forma desejada, ou seja, configurar em Verdadeiro para uma ligação digital e em Falso para uma ligação
analógica.

[Link].2.9 EnableCalc
Habilita ou desabilita o cálculo da média, mínimos e máximos dentro do intervalo.

[Link].2.10 EnableHighLimit
Habilita ou desabilita a verificação do limite alto.

[Link].2.11 EnableLowLimit
Habilita ou desabilita a verificação do limite baixo.

[Link].2.12 EU
Esta propriedade é utilizada para identificar a unidade de engenharia que o valor representa, como por exemplo
graus, metros e KW/h, entre outros.

[Link].2.13 HighlightMaxGapTime
Especifica se a linha que conecta visualmente a parte histórica e a parte de tempo real de uma Pena do tipo
Histórica e Tempo Real (definida em MaxGapTime) deve ter uma cor (definida na propriedade MaxGapTimeColor) e
um estilo (definido na propriedade MaxGapTimeStyle) diferenciados. O valor padrão desta propriedade é Falso.

[Link].2.14 HighLimit
Determina o limite de alarme alto.

[Link].2.15 InterpolatedBeginY
Informa o valor do ponto interpolado onde o cursor inicial cruza com a Pena. Esta propriedade é somente de leitura.

[Link].2.16 InterpolatedEndY
Informa o valor do ponto interpolado onde o cursor final cruza com a Pena. Esta propriedade é somente de leitura.

[Link].2.17 LimitPenBkColor
Determina a cor de fundo da Pena quando em alarme. O valor padrão desta propriedade é vermelho (RGB(255, 0,
0)).

[Link].2.18 LimitPenColor
Determina a cor da Pena quando em alarme. O valor padrão desta propriedade é vermelho (RGB(255, 0, 0)).

[Link].2.19 LowLimit
Determina o limite de alarme baixo.

[Link].2.20 MaxGapTime
Permite especificar um tempo limite, em segundos, a ser considerado para a conexão visual entre a parte histórica e
a parte de tempo real de uma Pena do tipo Histórica e Tempo Real. O valor padrão desta propriedade é 0 (zero).

NOTA
Esta propriedade está disponível a partir da versão 3.5. Para aplicações criadas em versões anteriores e abertas na
versão 3.5, o valor da propriedade é sempre 0 (zero).

[Link].2.21 MaxGapTimeColor
Permite configurar a cor da conexão visual entre a parte histórica e a parte de tempo real de uma Pena do tipo
Histórica e Tempo Real, definida na propriedade MaxGapTime. O valor padrão desta propriedade é vermelho
(RGB(255, 0, 0)).

222 Visualização
[Link].2.22 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 do tipo Histórica e Tempo Real, configurada na propriedade MaxGapTime. Os valores possíveis para esta
propriedade são 0: Sólida, 1: Tracejada, 2: Pontilhada (padrão), 3: Traço - Ponto, 4: Traço - Ponto - Ponto ou 5:
Invisível.

NOTA
A opção 5 (Invisível) desta propriedade só pode ser selecionada via script.

[Link].2.23 MaxY
Informa o valor máximo da Pena no intervalo, caso a propriedade EnableCalc esteja habilitada. Caso o E3Chart
esteja no modo de Pesquisa de Intervalos, mostra a média nesse intervalo. Do contrário, mostra a média no intervalo
entre o início e o fim no Eixo Horizontal. Valores com qualidade ruim não são considerados caso a propriedade
ShowBadPoints esteja desabilitada. Esta propriedade é somente de leitura.

[Link].2.24 MinY
Informa o valor mínimo da Pena no intervalo, caso a propriedade EnableCalc esteja habilitada. Caso o E3Chart
esteja no modo de Pesquisa de Intervalos, mostra a média nesse intervalo. Do contrário, mostra a média no intervalo
entre o início e o fim no Eixo Horizontal. Valores com qualidade ruim não são considerados caso a propriedade
ShowBadPoints esteja desabilitada. Esta propriedade é somente de leitura.

[Link].2.25 Name
Determina o nome da Pena. Consulte a propriedade geral Name para mais informações sobre os caracteres
permitidos no nome deste objeto.

[Link].2.26 PenLineStyle
Determina o estilo de linha da Pena. As opções disponíveis estão descritas na tabela a seguir.
Opções disponíveis para a propriedade PenLineStyle
OPÇÃO DESCRIÇÃO
0 - LsSolid Linha sólida (padrão)

1 - LsDash Linha tracejada

2 - LsDot Linha pontilhada

3 - LsDashDot Linha traço-ponto

4 - LsDashDotDot Linha traço-ponto-ponto

5 - LsNull Sem linha

NOTA
A utilização de um valor diferente de 0 (zero, LsSolid) nesta propriedade, combinada com a utilização da
propriedade Width com valores maiores do que 1 (um), pode degradar a performance de desenho da Pena.

[Link].2.27 PenType
Determina o tipo de desenho da Pena no E3Chart. Os valores possíveis são 0: Linha (padrão), 1: Ponto, 2: Ponto e
Linha ou 3: Área.

[Link].2.28 QueryName
Determina o nome da Consulta que a Pena está utilizando. Esta propriedade é utilizada se a propriedade
DataSourceType está configurada em 1 (um, Histórico).

Visualização 223
[Link].2.29 ScaleX
Esta propriedade indica a escala X do E3Chart a qual a Pena está associada. A escala configurada para esta
propriedade tem orientação horizontal, ou seja, pode estar posicionada no topo ou na base do E3Chart. O script a
seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set Chart = [Link]("E3Chart1")
Set Pen = [Link]("PenaDoTagDemo2")
[Link] = "Dados.TagDemo2"
[Link] = True
' A escala deve existir previamente.
[Link] = "EscalaParaTagDemo2"
[Link]()
End Sub

Esta propriedade não tem efeito quando a propriedade UseAutomaticAxis está configurada para Verdadeiro.

[Link].2.30 ScaleY
Esta propriedade indica a escala Y do E3Chart a qual a Pena está associada. A escala configurada para esta
propriedade tem orientação vertical, estando posicionada à esquerda ou à direita do E3Chart. O script a seguir
contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set Chart = [Link]("E3Chart1")
Set Pen = [Link]("PenaDoTagDemo2")
[Link] = "Dados.TagDemo2"
[Link] = True
' A escala deve existir previamente.
[Link] = "EscalaParaTagDemo2"
[Link]()
End Sub

Esta propriedade não tem efeito quando a propriedade UseAutomaticAxis está configurada para Verdadeiro.

[Link].2.31 ScanValue
Define o tempo de leitura esperado do Tag da Pena do tipo Tempo Real. Este valor é levado em conta no modo de
desenho analógico. Quando o valor ultrapassa o valor determinado por esta propriedade, considera-se que o valor
do Tag não foi alterado no intervalo. De outra forma, quando o valor desta propriedade é 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.

[Link].2.32 ShowAverage
Habilita a exibição da média da Pena no E3Chart. Esta propriedade só tem efeito caso a propriedade EnableCalc
esteja habilitada.

[Link].2.33 ShowBadPoints
Quando esta propriedade está 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 esta propriedade está habilitada, todos os pontos são plotados normalmente.

[Link].2.34 ShowMinMax
Habilita a exibição dos pontos mínimo e máximo da Pena no E3Chart. Esta propriedade só tem efeito caso a
propriedade EnableCalc esteja habilitada.

[Link].2.35 UseAutomaticAxis
Esta propriedade, quando configurada em Verdadeiro, permite que a Pena seja plotada utilizando um Eixo
automático, que recebe os limites mínimos e máximos das configurações da unidade de engenharia do Tag no
servidor. Neste caso, as propriedades ScaleX (Eixo Horizontal) e ScaleY (Eixo Vertical) não são utilizadas.

224 Visualização
[Link].2.36 UseTimeStamp
Determina que seja utilizado, para o Eixo Horizontal, o valor da estampa de tempo associada ao Eixo Vertical.
Consulte um exemplo na propriedade DataSourceType.

[Link].2.37 Visible
Determina se a Pena está visível no E3Chart. Se esta propriedade está configurada para Verdadeiro, a Pena é visível
em tempo de execução. Caso contrário, a Pena permanece invisível. O script a seguir contém um exemplo de uso
desta propriedade.
Sub CommandButton1_Click()
Set Pen1 = [Link]("E3Chart1").[Link]("Pen1")
[Link] = Not [Link]
End Sub

[Link].2.38 Width
Determina a largura da linha da Pena no E3Chart. O valor padrão desta propriedade é 0 (zero).

NOTA
A utilização de valores maiores do que 1 (um) nesta propriedade, combinada com a utilização da propriedade
PenLineStyle com um valor diferente de 0 (zero, LsSolid), pode degradar a performance de desenho da Pena.

[Link].2.39 XField
Nome do campo da Consulta usado para plotar um dado em uma escala horizontal. Esta propriedade é usada para
Penas do tipo Histórica.

[Link].2.40 XLink
Nome do link usado para plotar um dado em uma escala horizontal. Quando o valor desta propriedade é alterado,
a Pena é automaticamente desconectada. Após a configuração, use o método Connect para que a Pena comece a
receber os dados relativos a este link. Esta propriedade é usada para Penas do tipo Tempo Real.

[Link].2.41 XMaxY
Informa o valor X relativo ao ponto MaxY. Esta propriedade é somente de leitura.

[Link].2.42 XMinY
Informa o valor X relativo ao ponto MinY. Esta propriedade é somente de leitura.

[Link].2.43 YField
Nome do campo da Consulta usado para plotar um dado em uma escala vertical. Esta propriedade é usada para
Penas do tipo Histórica.

[Link].2.44 YLink
Nome do link usado para plotar um dado em uma escala vertical. Quando o valor desta propriedade é alterado, a
Pena é automaticamente desconectada. Após a configuração, use o método Connect para que a Pena comece a
receber os dados relativos a este link.

4.6.7 Legenda
Esta seção contém informações sobre métodos e propriedades do objeto Legenda (Legend). Este objeto não possui
eventos associados.

[Link] 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.

Visualização 225
 Opções disponíveis para identificação das colunas
OPÇÃO VALOR NOME DESCRIÇÃO
Cor da Pena 6 Color Mostra a cor da Pena

Descrição da Pena 5 Description Mostra a propriedade

DocString da Pena

DifX 15 DiffX Mostra a diferença entre os

cursores inicial e final

DifY 16 DiffY Mostra a diferença entre os

pontos interpolados inicial
e final no Eixo Y

EscalaX 8 ScaleX Mostra o nome da escala

associada ao Tag X

EscalaY 9 ScaleY Mostra o nome da escala

associada ao Tag Y

EscalaYMáx 20 ScaleYMax Mostra o valor máximo da

escala vertical

EscalaYMín 21 ScaleYMin Mostra o valor mínimo da

escala vertical

Estado 7 Status Mostra o status da Pena

FimX 14 XEnd Mostra a posição final do

cursor

FimY 18 YEnd Mostra o ponto interpolado

onde o cursor final cruza a
Pena

InícioX 13 XBegin Mostra a posição inicial do

cursor

InícioY 17 YBegin Mostra o ponto interpolado

onde o cursor inicial cruza a
Pena

MáximoY 12 MaxY Mostra o valor máximo da

Pena no intervalo

MédiaY 10 AverageY Mostra o valor médio da

Pena no intervalo

MínimoY 11 MinY Mostra o valor mínimo da

Pena no intervalo

Nome da pena 0 Name Mostra o nome da Pena

Nome do tag X 1 TagX Mostra o nome do Tag X

associado à Pena

Nome do tag Y 2 TagY Mostra o nome do Tag Y

associado à Pena

Unidade 19 EU Mostra a unidade

associada à Pena

Valor do tag X 3 TagXValue Mostra o valor do Tag X

associado à Pena. Este
valor é mostrado quando o
gráfico está no modo de
Pesquisa

226 Visualização
 OPÇÃO VALOR NOME DESCRIÇÃO
Valor do tag Y 4 TagYValue Mostra o valor do Tag Y
associado à Pena. Este
valor é mostrado quando o
gráfico está no modo de
Pesquisa

[Link].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

O script a seguir contém um exemplo de uso deste método.

Sub CommandButton1_Click()
[Link]("E3Chart1").[Link] 1, 2
End Sub

[Link].2 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. Para mais informações, consulte 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

O script a seguir contém um exemplo de uso deste método.

Sub CommandButton1_Click()
'Mostra o nome da Pena
[Link]("E3Chart1").[Link] 0, 0
End Sub

Sub CommandButton1_Click()
'Mostra a cor da Pena
[Link]("E3Chart1").[Link] "Color", 0
End Sub

[Link].3 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.
Para mais informações, consulte a tabela Opções disponíveis para identificação das colunas, no início do tópico
Métodos da Legenda.

[Link].4 RemoveColumn
RemoveColumn(Col)
Remove uma coluna. Este método possui o parâmetro Col, que determina a coluna a ser removida. Para mais
informações, consulte a tabela Opções disponíveis para identificação das colunas, no início do tópico Métodos da
Legenda.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Legenda (Legend).

[Link].1 BackColor
Configura ou retorna a cor de fundo da Legenda. O valor padrão desta propriedade é branco (RGB(255, 255, 255)).

Visualização 227
[Link].2 BorderStyle
Esta propriedade determina o estilo de borda que é aplicada à Legenda do E3Chart. As opções disponíveis para
esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade BorderStyle
OPÇÃO DESCRIÇÃO
0 - lbsFlat Aplica uma borda plana na Legenda

1 - lbsRaised Aplica uma borda com um destaque na parte superior

esquerda e uma sombra na parte inferior direita da
Legenda

2 - lbsSunken Aplica uma borda com uma sombra na parte superior

esquerda e um destaque na parte inferior direita da
Legenda (padrão)

3 - lbsEtched Aplica uma borda que parece estar esculpida ao redor

da extremidade da Legenda

4 - lbsBump Aplica uma borda com um ressalto na parte inferior

direita e parece plano na parte superior esquerda da
Legenda

[Link].3 Count
Retorna o número de colunas da Legenda.

[Link].4 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.

[Link].5 Font
Esta propriedade permite configurar o nome, o estilo e o tamanho da fonte da Legenda. O valor padrão desta
propriedade é a fonte Tahoma.

[Link].6 HeaderBackColor
Define a cor de fundo das colunas do cabeçalho da Legenda.

[Link].7 HeaderBorderStyle
Define o estilo das bordas das colunas do cabeçalho da Legenda. As opções disponíveis para esta propriedade
estão descritas na tabela a seguir.
Opções disponíveis para a propriedade HeaderBorderStyle
OPÇÃO DESCRIÇÃO
0 - lbsFlat Aplica uma borda plana na coluna do cabeçalho

1 - lbsRaised Aplica uma borda com um destaque na parte superior

esquerda e uma sombra na parte inferior direita da
coluna do cabeçalho

2 - lbsSunken Aplica uma borda com uma sombra na parte superior

esquerda e um destaque na parte inferior direita da
coluna do cabeçalho (padrão)

3 - lbsEtched Aplica uma borda que parece estar esculpida ao redor

da extremidade da coluna do cabeçalho

4 - lbsBump Aplica uma borda com um ressalto na parte inferior

direita e parece plano na parte superior esquerda da
coluna do cabeçalho

228 Visualização
[Link].8 HeaderTextColor
Define a cor do texto das colunas do cabeçalho da Legenda.

[Link].9 LegendPos
Indica a posição da Legenda no E3Chart. As opções disponíveis estão descritas na tabela a seguir.
Opções disponíveis para a propriedade LegendPos
OPÇÃO DESCRIÇÃO
0 - lgTop Mostra a Legenda no topo

1 - lgLeft Mostra a Legenda à esquerda

2 - lgBottom Mostra a Legenda na base (padrão)

3 - lgRight Mostra a Legenda à direita

[Link].10 ShowAllPens
Quando a propriedade é igual a Verdadeiro, todas as Penas do E3Chart são mostradas na Legenda. A propriedade
Visible da Pena é ignorada. Quando em Falso, somente as Penas com a propriedade Visible igual a Verdadeiro são
mostradas. O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set E3Chart1 = [Link]("E3Chart1")
[Link] = Not _
[Link]
End Sub

[Link].11 ShowBackground
Habilita a visualização de uma cor de fundo para a Legenda, configurada na propriedade BackColor. Caso esta
propriedade esteja configurada para Falso, a Legenda mostra como fundo a cor definida na propriedade BackColor
do E3Chart.

[Link].12 ShowHeader
Determina a visibilidade do título da Legenda (cabeçalho). Se a propriedade é configurada para Verdadeiro, o título
da Legenda é mostrado. Caso contrário, o título permanece invisível.

[Link].13 Size
Determina o tamanho da Legenda. Este tamanho pode significar a altura ou largura, dependendo da posição da
Legenda.

[Link].14 TextColor
Esta propriedade especifica a cor da fonte do texto a ser exibido na Legenda. 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)).

[Link].15 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.

[Link] Coluna da Legenda

Esta seção contém informações sobre propriedades do objeto Colunas da Legenda (LegendColumn). Este objeto não
possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Colunas da Legenda (LegendColumn).

Visualização 229
[Link].1.1 Caption
Permite definir um título para a Coluna.

[Link].1.2 Column
Retorna o identificador da Coluna. Para mais informações, consulte a tabela Opções disponíveis para
identificação das colunas, no início do tópico Métodos da Legenda. Esta propriedade é somente de leitura.

[Link].1.3 Format
Configura o formatador usado na Coluna.

[Link].1.4 Index
Retorna a posição da Coluna na Legenda. Esta propriedade é somente de leitura.

[Link].1.5 Name
Determina o nome da Coluna. O nome das Colunas pode ser consultado na Tabela de Identificação das Colunas,
no início do tópico Métodos da Legenda. Esta propriedade é somente de leitura.

[Link].1.6 TextAlign
Retorna o alinhamento do texto da Coluna. As opções disponíveis para esta propriedade estão descritas na tabela
a seguir.
Opções disponíveis para a propriedade TextAlign
OPÇÃO DESCRIÇÃO
0 - taLeft Alinhamento à esquerda (padrão)

1 - taRight Alinhamento à direita

2 - taCenter Alinhamento centralizado

[Link].1.7 Width
Retorna a largura da Coluna.

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.

[Link] Pause
Pause()
Congela o relógio de playback no tempo atual.

[Link] 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.

[Link] Stop
Stop()
Interrompe o playback, dados de Tags e alarmes são removidos das Telas e nenhuma nova consulta é realizada ao
Banco de Dados.

230 Visualização
4.7.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto E3Playback.

[Link] CurrentTime
Mostra a data e a hora atual do objeto E3Playback. Esta propriedade é somente de leitura.

[Link] DBServer
Indica o nome do objeto Banco de Dados que contém os dados históricos da aplicação.

[Link] 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.

[Link] PlaybackState
Informa o estado atual do objeto E3Playback. Esta propriedade é somente de leitura e as opções disponíveis estão
descritas na tabela a seguir.
Opções disponíveis para a propriedade PlaybackState
OPÇÃO DESCRIÇÃO
0 - Parado O relógio de playback está parado (padrão)

1 - Reproduzindo O relógio de playback está se movendo

2 - Pausado O relógio de playback está pausado

4.8 Relatório de Seção

Esta seção contém informações sobre eventos, métodos e propriedades do objeto Relatório de Seção
(E3SectionReport).

4.8.1 Eventos
Esta seção contém informações sobre os eventos do objeto Relatório de Seção (E3SectionReport).

[Link] DataInitialize
DataInitialize()
Disparado antes do evento ReportStart. Este evento permite acrescentar e configurar campos à coleção Fields de um
Relatório de Seção antes da geração.

[Link] FetchData
FetchData(eof)
Disparado toda vez que um novo registro é processado. Este evento é utilizado para executar um script que
modifique os valores dos campos adicionados ao Relatório de Seção em um script associado ao evento
DataInitialize. O parâmetro eof tem o valor padrão Verdadeiro e indica que após o script o processamento do
registro atual do Relatório de Seção é encerrado.

[Link] NoData
NoData()
Disparado quando não há dados a imprimir no Relatório de Seção. 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
de Seção.

[Link] PageEnd
PageEnd()
Disparado ao final da impressão de cada página do Relatório de Seção.

Visualização 231
[Link] PageStart
PageStart()
Disparado no início da impressão de cada página do Relatório de Seção.

[Link] ReportEnd
ReportEnd()
Disparado no final da geração do Relatório de Seção, após finalizar a impressão.

[Link] ReportStart
ReportStart()
Disparado no início da geração do Relatório de Seção, 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 de Seção (E3SectionReport).

[Link] Export
Export(ExportFormat, [ExportFileName], [ShowSaveDlg])
Exporta um Relatório de Seção para o arquivo especificado no parâmetro ExportFileName de acordo com o formato
especificado no parâmetro ExportFormat. As opções disponíveis para o parâmetro ExportFormat são as seguintes:
· PDF: Exporta os dados para um arquivo no formato PDF (Portable Document Format, padrão)
· Excel: Exporta os dados para um arquivo no formato de uma planilha do Excel (com a extensão .xlsx)
· HTML: Exporta os dados para um arquivo no formato HTML (Hyper Text Markup Language)
· RTF: Exporta os dados para um arquivo no formato RTF (Rich Text Format)
· Text: Exporta os dados para um arquivo no formato Texto

O parâmetro ShowSaveDlg é opcional e indica se a janela padrão de salvar arquivos é mostrada ou não. O valor
padrão deste parâmetro é Falso. Caso o parâmetro ExportFileName seja omitido, o Relatório de Seção é salvo na
pasta do Domínio com um nome padrão.

NOTA
Pode-se usar tanto a extensão .txt quanto a extensão .csv para o formato de exportação Text. Arquivos CSV
(Comma-Separated Values) são mais indicados para importação em bancos de dados ou planilhas do Excel.

[Link] GetExportFilter
GetExportFilter(Filter)
Retorna um objeto que permite configurar os parâmetros de exportação de um Relatório de Seção. Os valores
possíveis para o parâmetro Filter estão descritos na tabela a seguir.
Valores possíveis para o parâmetro Filter
VALOR DESCRIÇÃO
Excel Retorna um objeto do tipo
SectionReportExportFilterExcel, que permite configurar
a exportação de um Relatório de Seção para um arquivo
no formato de uma planilha do Excel

HTML Retorna um objeto do tipo

SectionReportExportFilterHTML, que permite configurar
a exportação de um Relatório de Seção para um arquivo
no formato HTML (Hyper Text Markup Language)

PDF Retorna um objeto do tipo

SectionReportExportFilterPDF, que permite configurar a
exportação de um Relatório de Seção para um arquivo
no formato PDF (Portable Document Format)

232 Visualização
 VALOR DESCRIÇÃO
RTF Retorna um objeto do tipo
SectionReportExportFilterWord, que permite configurar
a exportação de um Relatório de Seção para um arquivo
no formato RTF (Rich Text Format)

Text Retorna um objeto do tipo

SectionReportExportFilterText, que permite configurar a
exportação de um Relatório de Seção para um arquivo
no formato Texto

[Link] Print
Print([vbShowPrintDialog])
Imprime um Relatório de Seção. O parâmetro vbShowPrintDialog indica se deve ser mostrada uma caixa de diálogo de
seleção de impressora ou não. Este parâmetro é opcional e, se omitido, imprime um Relatório de Seção diretamente
na impressora padrão configurada no sistema operacional.

[Link] PrintPreview
PrintPreview([Left], [Top], [Width], [Height])
Gera uma prévia de impressão de um Relatório de Seção na tela. Se o Relatório de Seção é 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. O script a seguir contém um exemplo de uso deste método.
Sub CommandButton1_Click()
Set report = [Link]("[Relatório1]")
Inicio = [Link]("[Link]").Value
Final = [Link]("[Link]").Value
[Link]("Consulta1").SetVariableValue "Ini", Inicio
[Link]("Consulta1").SetVariableValue "Fim", Final
[Link]()
End Sub

NOTAS
· Este método não está disponível para Relatórios de Seção carregados usando o método LoadReport do Servidor.
· Este método corresponde ao Pick Imprimir Relatório.
· Se os parâmetros Left e Top não são definidos, a prévia de impressão é mostrada na posição (0, 0).
· Se os parâmetros Width e Height não são definidos, a prévia de impressão é criada com o tamanho de 500 x 500
pixels e a janela é aberta maximizada. Se apenas um dos parâmetros é definido, o outro parâmetro é configurado
para 500 pixels e a janela não é aberta maximizada.
· Os valores de tamanho neste método podem ser informados como números ou Strings. No caso de números, são
considerados em pixels. No caso de Strings, se acompanhados da unidade "hm", são interpretados como
Himetric. Qualquer outro caso é considerado em pixels.

[Link] Query
Query()
Retorna o objeto Consulta atualmente selecionado no Relatório de Seção. Para mais informações a respeito deste
objeto, consulte o capítulo Consultas. O script a seguir contém um exemplo de uso deste método.
Sub Rect_Click()
Set Query = [Link]("[Relatório3]").Query()
[Link]("Chave1", "XYZ")
End Sub

4.8.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Relatório de Seção (E3SectionReport).

Visualização 233
[Link] Caption
Contém o título do Relatório de Seção que aparece na barra de título da janela de visualização (preview). O valor
padrão desta propriedade é uma String vazia.

[Link] MultipageCols
Indica o número de colunas de uma página de um Relatório de Seção no modo de pré-visualização. O valor desta
propriedade varia entre 1 (um) e 5 (cinco). Esta propriedade só está disponível quando a propriedade
PreviewViewType está configurada com o valor 1 (um, rv2Multipage).

[Link] MultipageRows
Indica o número de linhas de uma página de um Relatório de Seção no modo de pré-visualização. O valor desta
propriedade varia entre 1 (um) e 4 (quatro). Esta propriedade só está disponível quando a propriedade
PreviewViewType está configurada com o valor 1 (um, rv2Multipage).

[Link] PreviewViewType
Indica como são exibidas as páginas de um Relatório de Seção no modo de pré-visualização. Os valores possíveis
para esta propriedade são 0 - rv2SinglePage: Exibe uma página de cada vez na área de pré-visualização, 1 -
rv2Multipage: Exibe uma ou mais páginas na área de pré-visualização, conforme a configuração das propriedades
MultipageCols e MultipageRows, ou 2 - rv2Continuous: Exibe as páginas sem mostrar quebras de página na área
de pré-visualização.

NOTA
Quando esta propriedade está configurada para 1 (um, rv2Multipage), o valor da propriedade ZoomLevel pode
ser sobrescrito para que as páginas se ajustem à área de pré-visualização. Se as propriedades MultipageCols e
MultipageRows estão configuradas para o valor 1 (um), o valor da propriedade ZoomLevel é usado no modo de
pré-visualização.

[Link] ShowSidebar
Mostra ou esconde a barra lateral do modo de pré-visualização de um Relatório de Seção.

[Link] ZoomLevel
Representa o nível de zoom em que um Relatório de Seção é aberto no modo de pré-visualização, em porcentagem.
O valor desta propriedade varia entre 10% e 800%. Esta propriedade pode ser configurada para o valor -1 (menos
um) para que o modo de pré-visualização se ajuste à largura do Relatório de Seção ou -2 (menos dois) para que o
modo de pré-visualização se ajuste à largura da página.

4.8.4 E3ApplicationLink
Esta seção contém informações sobre métodos do objeto E3ApplicationLink. Este objeto não possui eventos nem
propriedades associados.

NOTA
Este objeto só está disponível em scripts do objeto Relatório de Seção, que utiliza a linguagem de programação
Visual Basic .NET.

Para utilizar este objeto em um script do Relatório de Seção, é preciso criar uma instância deste objeto para realizar a
interface entre o Relatório de Seção e o Elipse E3, conforme o código a seguir.
Dim Application = [Link]([Link]("Reports.E3ApplicationLink"))

Este objeto instanciado pode então ser utilizado para acessar valores de Tags, Telas e do objeto Viewer diretamente
no script.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto do objeto E3ApplicationLink.

234 Visualização
[Link].1 GetScreenObject
GetScreenObject(Path, [Frame])
Este método funciona apenas em tempo de execução no Elipse E3 Viewer e retorna uma Tela. O parâmetro Path é
obrigatório e indica o caminho para uma Tela. O parâmetro Frame é opcional e indica em qual Quadro está uma Tela.
Se este parâmetro é omitido, usa o Quadro _top.

[Link].2 GetScreenValue
GetScreenValue(Path, [Frame], [Property])
Este método funciona apenas em tempo de execução no Elipse E3 Viewer e retorna o valor de uma propriedade de
uma Tela ou Quadro. O parâmetro Path é obrigatório e indica o caminho para um objeto de uma Tela ou Quadro.
Este parâmetro pode ser uma String vazia e, neste caso, indica o caminho para uma propriedade na Tela ou Quadro.
O parâmetro Frame é opcional e indica em qual Quadro está a Tela. Se este parâmetro é omitido, usa o Quadro _top.
O parâmetro Property indica o nome da propriedade que deve ser retornada. Se este parâmetro é omitido, retorna o
valor da propriedade Value.

[Link].3 GetServerObject
GetServerObject(Path)
Este método funciona tanto no Elipse E3 Studio quanto em tempo de execução e retorna um objeto no servidor. O
parâmetro Path é obrigatório e indica o caminho de um objeto no servidor.

[Link].4 GetServerValue
GetServerValue(Path, [Property])
Este método funciona tanto no Elipse E3 Studio quanto em tempo de execução e retorna o valor de uma propriedade
de um objeto no servidor. O parâmetro Path é obrigatório e indica o caminho de um objeto no servidor. O parâmetro
Property é opcional e indica o nome da propriedade a ser retornada. Se este parâmetro é omitido, retorna o valor da
propriedade Value.

[Link].5 GetViewerObject
GetViewerObject(Path)
Este método funciona apenas em tempo de execução no Elipse E3 Viewer e retorna um objeto Viewer ou um objeto
filho do objeto Viewer. O parâmetro Path é obrigatório e indica o caminho para um objeto filho do Viewer. Este
parâmetro pode ser uma String vazia e, neste caso, indica que deve ser retornado o próprio objeto Viewer.

[Link].6 GetViewerValue
GetViewerValue(Path, [Property])
Este método funciona apenas em tempo de execução no Elipse E3 Viewer e retorna o valor de uma propriedade do
objeto Viewer ou de um objeto filho do objeto Viewer. O parâmetro Path é obrigatório e indica o caminho para um
objeto filho do Viewer. Este parâmetro pode ser uma String vazia e, neste caso, indica que deve ser retornada uma
propriedade do objeto Viewer. O parâmetro Property é opcional e indica o nome da propriedade a ser retornada. Se
este parâmetro é omitido, retorna o valor da propriedade Value.

NOTA
Como o objeto Viewer não possui uma propriedade Value, não é permitido utilizar este método com o parâmetro
Path igual a uma String vazia e omitir o parâmetro Property.

4.8.5 ExportFilter
Esta seção contém informações sobre propriedades do objeto ExportFilter do Relatório de Seção
(SectionReportExportFilter). Este objeto não possui eventos nem métodos associados.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto ExportFilter do Relatório de Seção
(SectionReportExportFilter).

Visualização 235
[Link].1 ExportFilterType
Retorna o tipo de filtro de exportação de um Relatório de Seção. Esta propriedade é somente de leitura. Os valores
possíveis para esta propriedade são Excel (Planilha do Excel), HTML (Arquivo no formato HTML), PDF (Arquivo no
formato PDF), RTF (Arquivo no formato RTF) ou Text (Arquivo no formato Texto).

[Link] ExportFilterExcel
Esta seção contém informações sobre propriedades do objeto ExportFilterExcel do Relatório de Seção
(SectionReportExportFilterExcel). Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto ExportFilterExcel do Relatório de Seção
(SectionReportExportFilterExcel).

[Link].1.1 AutoRowHeight
Calcula a altura das linhas (Falso, padrão) ou deixa que a altura das linhas seja calculada automaticamente pelo
Excel (Verdadeiro).

[Link].1.2 CellMerging
Define se as células devem ser mescladas (Verdadeiro) ou não (Falso, padrão), onde aplicável.

[Link].1.3 DisplayGridLines
Define se as linhas de grade devem (Verdadeiro, padrão) ou não (Falso) ser exibidas no Excel.

[Link].1.4 MinColumnWidth
Largura mínima das colunas, em polegadas. O valor padrão desta propriedade é 0.1.

[Link].1.5 MinRowHeight
Altura mínima das linhas, em polegadas. O valor padrão desta propriedade é 0.1.

[Link].1.6 MultiSheet
Define se deve ser exportada uma página por tabela (Verdadeiro) ou todas as páginas em uma única tabela (Falso,
padrão).

[Link].1.7 Password
Define uma senha para abrir o arquivo Excel exportado.

[Link].1.8 TrimVerticalSpace
Define se deve ser removido o espaço vertical em branco (Verdadeiro) ou não (Falso, padrão).

[Link].1.9 WritePassword
Define uma senha para escrita no arquivo Excel exportado.

[Link].1.10 XLSFileFormat
Formato do arquivo a ser exportado. Os valores possíveis para esta propriedade são 0 - rv2XLSFormat97Plus:
Formato usado pelo Excel 97, com extensão .xls, 1 - rv2XLSFormat95: Formato usado pelo Excel 95, com extensão .xls,
ou 2 - rv2XLSFormatXLSX: Formato usado pelo Excel 2007 ou posterior, com extensão .xlsx (padrão).

[Link] ExportFilterHTML
Esta seção contém informações sobre propriedades do objeto ExportFilterHTML do Relatório de Seção
(SectionReportExportFilterHTML). Este objeto não possui eventos nem métodos associados.

236 Visualização
[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto ExportFilterHTML do Relatório de Seção
(SectionReportExportFilterHTML).

[Link].1.1 Multipage
Define se um Relatório de Seção deve ser exportado em várias páginas HTML (Verdadeiro) ou em uma única página
HTML (Falso, padrão).

[Link].1.2 Title
Define o título da página HTML.

[Link].1.3 TrimVerticalSpace
Define se deve ser removido o espaço vertical em branco (Verdadeiro) ou não (Falso, padrão).

[Link] ExportFilterPDF
Esta seção contém informações sobre propriedades do objeto ExportFilterPDF do Relatório de Seção
(SectionReportExportFilterPDF). Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto ExportFilterPDF do Relatório de Seção
(SectionReportExportFilterPDF).

[Link].1.1 OwnerPassword
Define a senha para o proprietário do arquivo PDF exportado.

[Link].1.2 UserPassword
Define a senha do usuário do arquivo PDF exportado.

[Link].1.3 UserPermissions
Permite especificar as permissões para um usuário do arquivo PDF exportado. Os valores possíveis para esta
propriedade são 0 - rv2PermissionNone: Nenhuma permissão, 4 - rv2PermissionPrint: Permissão somente de
impressão de um arquivo, 8 - rv2PermissionModifyContents: Permissão de modificar o conteúdo de um arquivo, 16
- rv2PermissionCopy: Permissão de copiar o conteúdo de um arquivo, 32 - rv2PermissionModifyAnnotation:
Permissão de modificar as anotações de um arquivo, 256 - rv2PermissionFillIn: Permissão de preencher formulários
em um arquivo, 512 - rv2PermissionAccessibleReaders: Permissão de abrir um arquivo em dispositivos com
acessibilidade ou 1024 - rv2PermissionAssembly: Permissão de inserir, remover e rotacionar páginas, além da
permissão de criar thumbnails e bookmarks, mesmo que a permissão de modificar o conteúdo (8, oito) não tenha sido
informada. O valor padrão desta propriedade é que o usuário tenha todas as permissões, ou seja, a soma de todos
os valores.

[Link] ExportFilterText
Esta seção contém informações sobre propriedades do objeto ExportFilterText do Relatório de Seção
(SectionReportExportFilterText). Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto ExportFilterText do Relatório de Seção
(SectionReportExportFilterText).

[Link].1.1 PageDelimiter
Define um texto como separador de páginas.

[Link].1.2 TextDelimiter
Define um texto como separador de campos.

Visualização 237
[Link].1.3 TrimVerticalSpace
Define se deve ser removido o espaço vertical em branco (Verdadeiro) ou não (Falso, padrão).

[Link] ExportFilterWord
Esta seção contém informações sobre propriedades do objeto ExportFilterWord do Relatório de Seção
(SectionReportExportFilterWord). Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto ExportFilterWord do Relatório de Seção
(SectionReportExportFilterWord).

[Link].1.1 EnableShapes
Permite exportar (Verdadeiro) ou não (Falso, padrão) linhas e formas no formato RTF (Rich Text Format).

[Link].1.2 Pagination
Indica se o documento exportado deve conter numeração de páginas (Verdadeiro, padrão) ou não (Falso).

4.8.6 Layout
Esta seção contém informações sobre propriedades do objeto Layout do Relatório de Seção (SectionReport). Este
objeto não possui eventos nem métodos associados.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Layout do Relatório de Seção (SectionReport).

NOTA
As propriedades aqui descritas são parte do objeto SectionReport, que é encapsulado no objeto Relatório de Seção
(E3SectionReport). Estas propriedades são válidas apenas dentro do escopo do Relatório de Seção e não podem
ser acessadas fora deste objeto.

[Link].1 MaxPages
Estabelece o número máximo de páginas para um Relatório de Seção. Quando este número é alcançado, o Elipse
E3 para de processar o documento. O valor padrão desta propriedade é 0 (zero), ou seja, sem limite de páginas.

[Link].2 PrintWidth
Determina a largura da área de impressão do Relatório de Seção, em polegadas. Se o tamanho do Relatório de
Seção é mudado em tempo de execução, a largura de impressão também deve ser ajustada, para garantir que o
Relatório de Seção ocupe toda a área de impressão. O tamanho da área de impressão deve também incluir a largura
das margens, para que o Relatório de Seção não ultrapasse o tamanho do papel. Se isto acontecer, o erro é
assinalado por uma linha pontilhada vermelha impressa em cada página do Relatório de Seção. O valor padrão desta
propriedade é 6,5 polegadas.

[Link].3 Watermark
Adiciona uma imagem de fundo, ou marca d'água, a um Relatório de Seção. As marcas d'água são textos ou
figuras que aparecem sob o texto do documento. Normalmente, estes textos ou figuras tornam o documento
visualmente mais interessante.

238 Visualização
 Exemplo de marca d'água
O valor padrão desta propriedade é vazio, ou seja, sem texto ou imagem.

[Link].4 WatermarkAlignment
Determina o alinhamento da marca d'água em um Relatório de Seção. 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 - rv2PicTopLeft Alinha a imagem ao topo e à esquerda

1 - rv2PicTopRight Alinha a imagem ao topo e à direita

2 - rv2PicCenter Alinha a imagem ao centro (padrão)

3 - rv2PicBottomLeft Alinha a imagem à base e à esquerda

4 - rv2PicBottomRight Alinha a imagem à base e à direita

[Link].5 WatermarkPrintOnPages
Indica o número das páginas de um Relatório de Seção que recebem uma 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, como por exemplo "1, 5-8,
9, 10-15".

[Link].6 WatermarkSizeMode
Configura o efeito do tamanho de uma marca d'água na página de um Relatório de Seção. As opções disponíveis
para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade WatermarkSizeMode
OPÇÃO DESCRIÇÃO
0 - rv2Clip A marca d'água é mostrada no Relatório de Seção no
tamanho original

1 - rv2Stretch A marca d'água preenche toda a página do Relatório de

Seção

2 - rv2Zoom A marca d'água é aumentada até atingir o tamanho da

página do Relatório de Seção

4.8.7 Objetos
Esta seção contém informações sobre propriedades dos Objetos de um Relatório de Seção. Estes objetos não
possuem eventos nem métodos associados.

Visualização 239
[Link] Propriedades Comuns
Esta seção contém informações sobre as propriedades comuns aos objetos de um Relatório de Seção.

[Link].1 Height
Esta propriedade determina a altura de um objeto em um Relatório de Seção.

NOTA
Esta propriedade não é válida para os objetos Linha e Quebra de Página.

[Link].2 Left
Retorna o valor do posicionamento esquerdo de um objeto em um Relatório de Seção.

NOTA
Esta propriedade não é válida para os objetos Linha e Quebra de Página.

[Link].3 Top
Retorna o valor do topo de um objeto. Esta propriedade é somente de leitura.

NOTA
Esta propriedade não é válida para o objeto Linha.

[Link].4 Visible
Determina a visibilidade de um objeto em um Relatório de Seção. O valor padrão desta propriedade é Verdadeiro
(visível).

NOTA
Esta propriedade não é válida para o objeto Quebra de Página.

[Link].5 Width
Esta propriedade determina a largura de um objeto em um Relatório de Seção.

NOTA
Esta propriedade não é válida para os objetos Linha e Quebra de Página.

[Link] Caixa de Seleção

Esta seção contém informações sobre propriedades do objeto Caixa de Seleção do Relatório de Seção
(SectionReportCheckBox). Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Caixa de Seleção do Relatório de Seção
(SectionReportCheckBox).

[Link].1.1 BackOpacity
Define se o fundo deste objeto é opaco ou não. Os valores possíveis para esta propriedade são 0 - rv2Opaque:
Fundo opaco ou 1 - rv2Transparent: Transparente (padrão).

[Link].1.2 CheckAlignment
Determina o posicionamento da caixa de seleção em relação à área deste objeto. Os valores possíveis para esta
propriedade são 1- rv2TopLeft: Alinhado ao topo e à esquerda, 2 - rv2TopCenter: Alinhado ao topo e ao centro, 4 -
rv2TopRight: Alinhado ao topo e à direita, 16 - rv2MIddleLeft: Alinhado ao centro e à esquerda (padrão), 32 -
rv2MiddleCenter: Alinhado ao centro, 64 - rv2MiddleRight: Alinhado ao centro e à direita, 256 - rv2BottomLeft:

240 Visualização
Alinhado à base e à esquerda, 512 - rv2BottomCenter: Alinhado à base e ao centro ou 1024 - BottomRight: Alinhado
à base e à direita.

[Link].1.3 Checked
Indica se esta Caixa de Seleção está selecionada ou não.

[Link].1.4 Font
Esta propriedade determina a fonte do texto no objeto Caixa de Seleção. O valor padrão desta propriedade é uma
String vazia. Esta propriedade não pode ser utilizada em scripts ou em Associações e é configurada somente via
Elipse E3 Studio. Consulte o tópico Fonte para mais informações sobre as sub-propriedades desta propriedade.

[Link].1.5 Text
Define o texto que é mostrado na Caixa de Seleção.

[Link].1.6 WrapMode
Define o modo de quebra de texto mostrado nesta Caixa de Seleção. Os valores possíveis para esta propriedade
são 0 - rv2NoWrap: Sem quebra de texto, 1 - rv2WordWrap: A quebra de texto leva em conta palavras inteiras
(padrão) ou 2 - rv2CharWrap: A quebra de texto leva em conta apenas caracteres.

[Link] Campo de Dados

Esta seção contém informações sobre propriedades do objeto Campo de Dados do Relatório de Seção
(SectionReportField). Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Campo de Dados do Relatório de Seção
(SectionReportField).

[Link].1.1 Alignment
Determina o alinhamento do texto neste Campo de Dados. Os valores possíveis para esta propriedade são 0 -
rv2Left: Alinhamento de texto à esquerda (padrão), 1 - rv2Center: Alinhamento de texto ao centro, 2 - rv2Right:
Alinhamento de texto à direita ou 3 - rv2Justify: Alinhamento de texto justificado.

[Link].1.2 BackOpacity
Define se o fundo deste objeto é opaco ou não. Os valores possíveis para esta propriedade são 0 - rv2Opaque:
Fundo opaco ou 1 - rv2Transparent: Transparente (padrão).

[Link].1.3 CanGrow
Indica se este objeto pode aumentar a altura com base no conteúdo. O valor padrão desta propriedade é
Verdadeiro.

[Link].1.4 CanShrink
Indica se este objeto pode diminuir a altura com base no conteúdo. O valor padrão desta propriedade é Falso.

[Link].1.5 CharacterSpacing
Indica o espaçamento entre caracteres deste objeto, em pontos. O valor padrão desta propriedade é 0 (zero).

[Link].1.6 CountNullValues
Determina se valores nulos devem ser incluídos como 0 (zero) em campos de totalização. O valor padrão desta
propriedade é Falso.

[Link].1.7 DataField
Configura ou retorna o dado associado ao objeto Campo de Dados. Este dado associado pode ser um campo da
tabela no banco de dados fornecido pelo objeto Consulta, uma expressão matemática com campos da Consulta ou
um Tag ou propriedade do Elipse E3. Neste caso o valor atual da variável é mostrado ao realizar a impressão. O
valor padrão desta propriedade é vazio.

Visualização 241
NOTA
O servidor deve estar em execução para que o valor da variável possa ser capturado.

[Link].1.8 DistinctField
Determina o nome do campo que é usado pela função selecionada na propriedade SummaryFunc. Esta
propriedade só é válida se a função definida em SummaryFunc é do grupo de funções Distinct Summary, o qual
abrange as funções de números 9 (nove) até 15, e quando a propriedade SummaryType tem valor diferente de 0
(zero).

[Link].1.9 Font
Esta propriedade determina a fonte do texto no objeto Campo de Dados. O valor padrão desta propriedade é uma
String vazia. Esta propriedade não pode ser utilizada em scripts ou em Associações e é configurada somente via
Elipse E3 Studio. Consulte o tópico Fonte para mais informações sobre as sub-propriedades desta propriedade.

[Link].1.10 Hyperlink
Esta propriedade determina o link que é atribuído ao texto do Campo de Dados.

[Link].1.11 LineSpacing
Indica o espaçamento entre linhas deste objeto, em pontos. O valor padrão desta propriedade é 0 (zero).

[Link].1.12 Multiline
Esta propriedade indica se o texto de um Campo de Dados tem múltiplas linhas (Verdadeiro) ou se é uma caixa de
texto simples (Falso). Este comportamento pode ser visualizado quando um Elipse E3 Viewer está em execução. O
valor padrão desta propriedade é Verdadeiro.

[Link].1.13 OutputFormat
Configura o formato usado para mostrar o valor de um Campo de Dados. O valor padrão desta propriedade é
uma String vazia, ou seja, o valor é mostrado sem formatação.

[Link].1.14 RightToLeft
Indica se o texto do Campo de Dados é alinhado da direita para a esquerda (Falso, padrão) ou da esquerda para a
direita (Verdadeiro).

[Link].1.15 ShrinkToFit
Indica se a fonte do texto do Campo de Dados pode diminuir para se ajustar ao conteúdo (Falso, padrão) ou não
pode diminuir (Verdadeiro).

[Link].1.16 SummaryFunc
Determina o tipo de função que é usada para processar os valores do campo especificado na propriedade
DataField, como listado na tabela a seguir. Esta propriedade só é válida quando a propriedade SummaryType tem
valor diferente de 0 (zero).
Opções disponíveis para a propriedade SummaryFunc
OPÇÃO DESCRIÇÃO
0 - rv2Sum Calcula a soma de todos os valores dentro do intervalo
de totais especificado (padrão para grupo, página ou
Relatório de Seção)

1 - rv2FAvg Calcula a média de todos os valores dentro do intervalo

de totais especificado (grupo, página ou Relatório de
Seção)

2 - rv2Count Conta o número de valores dentro do intervalo de totais

especificado (grupo, página ou Relatório de Seção)

242 Visualização
 OPÇÃO DESCRIÇÃO
3 - rv2Min Mostra o menor valor (valor mínimo) dentro do intervalo
de totais especificado (grupo, página ou Relatório de
Seção)

4 - rv2Max Mostra o maior valor (valor máximo) dentro do intervalo

de totais especificado (grupo, página ou Relatório de
Seção)

5 - rv2Var Calcula a variância dos valores dentro do intervalo de

totais especificado (grupo, página ou Relatório de Seção)

6 - rv2VarP Calcula a variância populacional dos valores dentro do

intervalo de totais especificado (grupo, página ou
Relatório de Seção)

7 - rv2StdDev Calcula o desvio padrão dos valores dentro do intervalo

de totais especificado (grupo, página ou Relatório de
Seção)

8 - rv2StdDevP Calcula o desvio padrão populacional dos valores dentro

do intervalo de totais especificado (grupo, página ou
Relatório de Seção)

9 - rv2DSum Calcula a soma de todos os valores distintos dentro do

intervalo de totais especificado (grupo, página ou
Relatório de Seção)

10 - rv2DAvg Calcula a média baseada nos valores distintos dentro do

intervalo de totais especificado (grupo, página ou
Relatório de Seção)

11 - rv2DCount Conta o número dos valores distintos dentro do intervalo

de totais especificado (grupo, página ou Relatório de
Seção)

12 - rv2DVar Calcula a variância dos valores distintos dentro do

intervalo de totais especificado (grupo, página ou
Relatório de Seção)

13 - rv2DVarP Calcula a variância populacional dos valores distintos

dentro do intervalo de totais especificado (grupo, página
ou Relatório de Seção)

14 - rv2DStdDev Calcula o desvio padrão dos valores dentro do intervalo

de totais especificado (grupo, página ou Relatório de
Seção)

15 - rv2DStdDevP Calcula o desvio padrão populacional dos valores

distintos dentro do intervalo de totais especificado
(grupo, página ou Relatório de Seção)

[Link].1.17 SummaryGroup
Esta propriedade só é válida quando a propriedade SummaryType é igual a 3 - SubTotal. Esta propriedade indica
qual o nome da Seção GroupHeader que é usada para controlar os subtotais, ou seja, a cada mudança de valor no
GroupHeader, o somatório é reiniciado.

NOTA
Quando esta propriedade é utilizada, as propriedades CanShrink e CanGrow permanecem desabilitadas.

[Link].1.18 SummaryRunning
Determina se é realizado o total de somatórios acumulados. Os valores possíveis para esta propriedade são 0 -
rv2NoSR: Não realiza o cálculo de total (padrão), 1 - rv2Group: Calcula os totais acumulados para cada intervalo de
totais especificado ou 2 - rv2All: Calcula o total acumulado para todos os valores do Relatório de Seção,

Visualização 243
independente do agrupamento. Esta propriedade só é válida quando a propriedade SummaryType tem valor
diferente de 0 (zero).

[Link].1.19 SummaryType
Determina o tipo ou o nível de totalização a ser gerado. As opções disponíveis para esta propriedade estão
descritas na tabela a seguir.
Opções disponíveis para a propriedade SummaryType
OPÇÃO DESCRIÇÃO
0 - rv2NoST Sem geração de somatório (padrão)

1 - rv2GrandTotal Especifica que é totalizado todo o conteúdo do Relatório

de Seção

2 - rv2PageTotal Especifica que é gerado um subtotal por página

3 - rv2SubTotal Especifica que é gerado um subtotal para cada grupo,

definido na propriedade SummaryGroup

4 - rv2PageCount Especifica o contador de páginas

[Link].1.20 Text
Determina o texto que é atribuído ao objeto Campo de Dados.

[Link].1.21 VerticalAlignment
Determina o alinhamento vertical do objeto Campo de Dados. Os valores possíveis para esta propriedade são 0 -
rv2Top: Alinhamento pelo topo (padrão), 1 - rv2Middle: Alinhamento pelo centro ou 2 - rv2Bottom: Alinhamento pela
base.

[Link].1.22 VerticalText
Indica se o texto do Campo de Dados deve ser desenhado na vertical (Verdadeiro) ou na horizontal (Falso, padrão).

[Link].1.23 WrapMode
Define o modo de quebra de texto mostrado neste Campo de Dados. Os valores possíveis para esta propriedade
são 0 - rv2NoWrap: Sem quebra de texto, 1 - rv2WordWrap: A quebra de texto leva em conta palavras inteiras
(padrão) ou 2 - rv2CharWrap: A quebra de texto leva em conta apenas caracteres.

[Link] Código de Barras

Esta seção contém informações sobre propriedades do objeto Código de Barras do Relatório de Seção
(SectionReportBarcode). Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Código de Barras do Relatório de Seção
(SectionReportBarcode).

[Link].1.1 Alignment
Determina o alinhamento do texto neste Código de Barras. Os valores possíveis para esta propriedade são 0 -
rv2Left: Alinhamento de texto à esquerda (padrão), 1 - rv2Center: Alinhamento de texto ao centro, 2 - rv2Right:
Alinhamento de texto à direita ou 3 - rv2Justify: Alinhamento de texto justificado.

[Link].1.2 AutoSize
Indica se o código de barras automaticamente se ajusta ao tamanho deste controle (Verdadeiro, padrão) ou não se
ajusta ao tamanho deste controle (Falso).

[Link].1.3 BackOpacity
Define se o fundo deste objeto é opaco ou não. Os valores possíveis para esta propriedade são 0 - rv2Opaque:
Fundo opaco ou 1 - rv2Transparent: Transparente (padrão).

244 Visualização
[Link].1.4 BarHeight
Indica a altura do código de barras, em polegadas. O valor padrão desta propriedade é 0 (zero). Se a altura do
código de barras excede a altura do controle, esta propriedade é ignorada.

[Link].1.5 CaptionGrouping
Indica se devem ser adicionados espaços entre grupos de caracteres na legenda deste controle para tornar
números grandes mais fáceis de ler. Esta propriedade só está disponível em alguns estilos de código de barras.

[Link].1.6 CaptionPosition
Especifica a posição do texto indicado na propriedade Text. Os valores possíveis para esta propriedade são 0 -
rv2NoCaption: O texto não aparece no Código de Barras (padrão), 1 - rv2Above: O texto aparece acima do Código
de Barras ou 2 - rv2Below: O texto aparece abaixo do Código de Barras.

[Link].1.7 CheckSumEnabled
Habilita (padrão) ou desabilita a leitura do valor de checksum (caractere de objeto do Código de Barras). Se esta
propriedade está configurada para Falso, somente códigos com checksum são afetados.

[Link].1.8 DataField
Configura ou retorna o dado associado ao objeto Código de Barras. Este dado associado pode ser um campo da
tabela no banco de dados fornecido pelo objeto Consulta, uma expressão matemática com campos da Consulta ou
um Tag ou propriedade do Elipse E3. Neste caso, o valor atual da variável é mostrado ao realizar a impressão. O
valor padrão desta propriedade é uma String vazia.

NOTA
O servidor deve estar em execução para que o valor da variável possa ser capturado.

[Link].1.9 NarrowBarWidth
Indica a largura da parte mais estreita do código de barras, em pixels. O valor padrão desta propriedade é 0 (zero).

[Link].1.10 Style
Determina o estilo do código de barras. As opções disponíveis para esta propriedade estão descritas na tabela a
seguir.
Opções disponíveis para a propriedade Style
OPÇÃO DESCRIÇÃO
0 - rv2NoBarcode Estilo de código de barras padrão

1 - rv2Ansi39 Estilo de código de barras ANSI 3 de 9 (Código 39).

Utiliza letras, números, -, *, $, /, + e %, entre outros

2 - rv2Ansi39x Estilo de código de barras ANSI estendido 3 de 9

(Código estendido 39). Utiliza caracteres completos ASCII

3 - rv2Code_2_of_5 Estilo de código de barras 2 de 5. Utiliza somente

números

4 - rv2Code25intlv Estilo de código de barras intercalado 2 de 5. Utiliza

somente números

5 - rv2Code25mat ou rv2Matrix_2_of_5 Estilo de código de barras Matriz 25

6 - rv2Code39 Estilo de código de barras Código 39. Utiliza letras,

números, -, *, $, /, + e %, entre outros

7 - rv2Code39x Estilo de código de barras Código 39 estendido. Utiliza

caracteres completos ASCII

8 - rv2Code_128_A Estilo de código de barras Código 128 A. Utiliza

números, pontuação, ou letras

Visualização 245
 OPÇÃO DESCRIÇÃO
9 - rv2Code_128_B Estilo de código de barras Código 128 B. Utiliza Strings,
números, pontuação ou letras

10 - rv2Code_128_C Estilo de código de barras Código 128 C. Utiliza somente

números

11 - rv2Code_128auto Estilo de código de barras Código 128 Automático.

Utiliza caracteres completos ASCII. Seleciona
automaticamente códigos entre 128 A, B e C para
configurar no código de barras o valor menor

12 - rv2Code_93 Estilo de código de barras Código 93. Utiliza letras,

números, -, *, $, /, + e %, entre outros

13 - rv2Code93x Estilo de código de barras Código 93 estendido. Utiliza

caracteres completos ASCII

14 - rv2MSI Estilo de código de barras Código MSI. Utiliza somente

números

15 - rv2PostNet Estilo de código de barras PostNet. Utiliza somente

números com um dígito de verificação

16 - rv2Codabar Estilo de código de barras Codabar. Utiliza A, B, C, D, +, -

, :, / ou números

17 - rv2EAN_8 Estilo de código de barras EAN-8. Utiliza somente

números (sete números e dígito de verificação)

18 - rv2EAN_13 Estilo de código de barras EAN-13. Utiliza somente

números (12 números e dígito de verificação)

19 - rv2UPC_A Estilo de código de barras UPC-A. Utiliza somente

números (11 números e dígito de verificação)

20 - rv2UPC_E0 Estilo de código de barras UPC-E1. Utiliza somente

números. Usado para símbolos de compressão-zero
UPC. Na propriedade Text pode-se digitar seis dígitos
do código UPC-E ou 11 dígitos. Se um código com 11
dígitos é inserido, o código de barras converte para seis
dígitos UPC-E, se possível. Senão, converte-se de 11 para
seis dígitos UPC-E e nada é mostrado

21 - rv2UPC_E1 Estilo de código de barras UPC-E1. Utiliza somente

números. A largura da entrada de dados do UPC E1 é de
seis caracteres numéricos

22 - rv2RM4SCC Estilo de código de barras Royal Mail RM4SCC. Utiliza

somente letras e números com dígito de verificação. Este
código de barras é utilizado no Reino Unido

23 - rv2UCCEAN128 Estilo de código de barras UCC/EAN_128. Utiliza

caracteres completos ASCII. A versão especial do código
128 é usado na aplicação HIBC

24 - rv2QRCode Estilo de código de barras bidimensional que permites

caracteres numéricos, alfanuméricos e binários, além de
caracteres kanji e kana

25 - rv2Code49 Estilo de código de barras bidimensional de alta

densidade contendo entre duas e oito linhas de oito
caracteres cada

26 - rv2JapanesePostal Estilo de código de barras usado pelo sistema de

correios japonês

27 - rv2Pdf417 Estilo de código de barras bidimensional de alta

densidade que permite codificar até 1108 bytes de
informação

246 Visualização
 OPÇÃO DESCRIÇÃO
28 - rv2EAN128FNC1 Estilo de código de barras alfanumérico para
identificação de contêineres na indústria de transportes
marítimos

29 - rv2RSS14 Estilo de código de barras formado por 14 caracteres

numéricos

30 - rv2RSS14Truncated Estilo de código de barras formado por 14 caracteres

numéricos, incluindo 0 (zero) ou mais dígitos para uso
em pequenos itens

31 - rv2RSS14Stacked Estilo de código de barras formado por 14 caracteres

numéricos em duas linhas por economia de espaço

32 - rv2RSS14StackedOmnidirectional Estilo de código de barras formado por 14 caracteres

numéricos em duas linhas por economia de espaço

33 - rv2RSSExpanded Estilo de código de barras formado por 14 caracteres

numéricos, incluindo informações tais como peso e data
de validade

34 - rv2RSSExpandedStacked Estilo de código de barras formado por 14 caracteres

numéricos, incluindo informações tais como peso e data
de validade, disposto em duas linhas por economia de
espaço

35 - rv2RSSLimited Estilo de código de barras formado por 14 caracteres

numéricos, incluindo 0 (zero) ou mais dígitos para uso
em pequenos itens

36 - rv2DataMatrix Estilo de código de barras bidimensional de alta

densidade com módulos quadrados arranjados em um
padrão de matriz retangular ou quadrada

37 - rv2MicroPDF417 Estilo de código de barras bidimensional derivado do

estilo rv2Pdf417, permite codificar até 150 bytes, 250
caracteres numéricos ou 366 dígitos

38 - rv2MicroQRCode Estilo de código de barras bidimensional indicado para

aplicações que usam pequenas quantidades de dados

39 - rv2MaxiCode Estilo de código de barras especial que usa 256

caracteres, indicado para quantidades específicas de
dados

40 - rv2GS1QRCode Estilo de código de barras bidimensional que é um sub-

conjunto do estilo rv2QRCode

41 - rv2GS1DataMatrix Estilo de código de barras bidimensional usado na

indústria de saúde

42 - rv2Aztec Estilo de código de barras bidimensional que suporta os

caracteres ASCII de 0 (zero) até 255

64 - rv2IntelligentMail Estilo de código de barras usado para correspondências

domésticas nos Estados Unidos

65 - rv2ITF14 Estilo de código de barras intercalado 2 de 5

66 - rv2Code_11 Estilo de código de barras que codifica números (0-9),

hífen (-) e caracteres de início e parada, usado para
equipamentos de telecomunicação

67 - rv2SSCC_18 Estilo de código de barras composto de 18 caracteres

para identificação de contêineres individuais

68 - rv2Telepen Estilo de código de barras composto por um caractere

de início, um dígito de verificação e um caractere de
parada, usado na indústria manufatureira

Visualização 247
 OPÇÃO DESCRIÇÃO
69 - rv2Pharmacode Estilo de código de barras composto apenas por
números entre 3 (três) e 131070, usado pela indústria
farmacêutica

70 - rv2PZN Estilo de código de barras com o mesmo algoritmo do

estilo rv2Code39, exceto que utiliza somente dígitos
entre 0 (zero) e 9 (nove), usado para identificação de
medicamentos e produtos de saúde na Alemanha

71 - rv2HIBCCode128 Estilo de código de barras que usa o mesmo algoritmo

do estilo Código 128, usado para identificação de
produtos de saúde

72 - rv2HIBCCode39 Estilo de código de barras que usa o mesmo algoritmo

do estilo rv2Code39, usado para identificação de
produtos de saúde

73 - rv2ISBN Estilo de código de barras ISBN (International Standard

Book Number)

74 - rv2ISSN Estilo de código de barras ISSN (International Standard

Serial Number)

75 - rv2ISMN Estilo de código de barras ISMN (International Standard

Music Number)

76 - rv2IATA_2_of_5 Estilo de código de barras que é uma variação do estilo

rv2Code_2_of_5, exceto que utiliza somente números com
um dígito de verificação

77 - rv2BC412 Estilo de código de barras que usa números e caracteres

de A a Z, usado para identificação de pastilhas
semicondutoras

78 - rv2Plessey Estilo de código de barras unidimensional que usa

dígitos hexadecimais, usado principalmente em
bibliotecas

79 - rv2IntelligentMailPackage Estilo de código de barras mais eficiente que o estilo

rv2IntelligentMail

[Link].1.11 Text
Contém o texto do código de barras. O valor padrão desta propriedade é uma String vazia.

[Link] Elipse, Retângulo e Retângulo Arredondado

Esta seção contém informações sobre propriedades dos objetos Elipse, Retângulo e Retângulo Arredondado do
Relatório de Seção (SectionReportShape). Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades dos objetos Elipse, Retângulo e Retângulo Arredondado do
Relatório de Seção (SectionReportShape).

[Link].1.1 BackColor
Especifica a cor usada quando a propriedade BackOpacity é igual a 0 - rv2Opaque. O valor padrão desta
propriedade é branco (RGB(255, 255, 255)).

[Link].1.2 BackColor2
Especifica a cor usada quando a propriedade BackOpacity2 é igual a 0 - rv2Opaque. O valor padrão desta
propriedade é preto (RGB(0, 0, 0)).

248 Visualização
[Link].1.3 BackgroundStyle
Determina o estilo de fundo dos objetos Elipse, Retângulo e Retângulo Arredondado. As opções disponíveis para
esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade BackgroundStyle
OPÇÃO DESCRIÇÃO
0 - rv2BackSolid Estilo de fundo sólido, usa a cor indicada na propriedade
BackColor

1 - rv2Gradient Estilo de fundo com gradiente, indo da cor indicada na

propriedade BackColor até a cor indicada na
propriedade BackColor2

2 - rv2Pattern Estilo de fundo gradeado, com fundo na cor indicada na

propriedade BackColor2 e linhas na cor indicada na
propriedade BackColor

[Link].1.4 BackOpacity
Define se o fundo deste objeto é opaco ou não. Os valores possíveis para esta propriedade são 0 - rv2Opaque:
Fundo opaco ou 1 - rv2Transparent: Transparente (padrão).

[Link].1.5 BackOpacity2
Define se o fundo deste objeto é opaco ou não. Os valores possíveis para esta propriedade são 0 - rv2Opaque:
Fundo opaco (padrão) ou 1 - rv2Transparent: Transparente.

[Link].1.6 LineColor
Especifica a cor da linha dos objetos Elipse, Retângulo e Retângulo Arredondado. O valor padrão desta
propriedade é preto (RGB(0, 0, 0)).

[Link].1.7 LineStyle
Determina o estilo da linha dos objetos Elipse, Retângulo e Retângulo Arredondado. As opções disponíveis para
esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade LineStyle
OPÇÃO DESCRIÇÃO
0 - rv2NoBorder A linha permanece transparente

1 - rv2Solid A linha aparece sólida (padrão)

2 - rv2Dashed A linha aparece tracejada

3 - rv2Dot A linha aparece pontilhada

4 - rv2DashDot A linha aparece com um padrão de traço e ponto

5 - rv2DashDotDot A linha aparece com um padrão de traço, ponto e ponto

6 - rv2Double A linha aparece com o dobro da largura indicada na

propriedade LineWeight

[Link].1.8 LineWeight
Especifica a largura da linha dos objetos Elipse, Retângulo e Retângulo Arredondado. Configurando a largura para 1
(um), a linha do objeto é expandida em até 15 pontos. Configurando a largura para 2 (dois), a linha é expandida em
até 30 pontos, e assim por diante. Quanto maior o número configurado na propriedade, maior a largura do objeto. O
valor padrão desta propriedade é 1 (um).

[Link].1.9 RoundingRadius
Especifica o raio de cada canto para o objeto Retângulo Arredondado, como uma porcentagem. O valor padrão
desta propriedade é 10 (dez por cento).

Visualização 249
[Link].1.10 Style
Determina qual forma vai ser desenhada. As opções disponíveis para esta propriedade estão descritas na tabela a
seguir.
Opções disponíveis para a propriedade Style
OPÇÃO DESCRIÇÃO
0 - rv2Rectangle Formato retangular

1 - rv2Ellipse Formato elíptico ou circular

2 - rv2RoundRect Formato de retângulo arredondado

[Link] Figura
Esta seção contém informações sobre propriedades do objeto Figura do Relatório de Seção (SectionReportPicture).
Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Figura do Relatório de Seção (SectionReportPicture).

[Link].1.1 BackOpacity
Define se o fundo deste objeto é opaco ou não. Os valores possíveis para esta propriedade são 0 - rv2Opaque:
Fundo opaco ou 1 - rv2Transparent: Transparente (padrão).

[Link].1.2 Image
Especifica o arquivo de imagem para um objeto Figura. As extensões permitidas são
.bmp, .cur, .emf, .gif, .ico, .jpg, .png, .tif ou .wmf. O valor padrão desta propriedade é uma String vazia.

[Link].1.3 LineColor
Especifica a cor da linha de um objeto Figura. O valor padrão desta propriedade é branco (RGB(255, 255, 255)).

[Link].1.4 LineStyle
Determina o estilo da linha de um objeto Figura. As opções disponíveis para esta propriedade estão descritas na
tabela a seguir.
Opções disponíveis para a propriedade LineStyle
OPÇÃO DESCRIÇÃO
0 - rv2NoBorder A linha permanece transparente (padrão)

1 - rv2Solid A linha aparece sólida

2 - rv2Dashed A linha aparece tracejada

3 - rv2Dot A linha aparece pontilhada

4 - rv2DashDot A linha aparece com um padrão de traço e ponto

5 - rv2DashDotDot A linha aparece com um padrão de traço, ponto e ponto

6 - rv2Double A linha aparece com o dobro da largura indicada na

propriedade LineWeight

[Link].1.5 LineWeight
Especifica a largura da linha de um objeto Figura. Configurando a largura para 1 (um), a linha do objeto é expandida
em até 15 pontos. Configurando a largura para 2 (dois), a linha é expandida em até 30 pontos, e assim por diante.
Quanto maior o número configurado na propriedade, maior a largura do objeto. O valor padrão desta propriedade é
0 (zero).

250 Visualização
[Link].1.6 PictureAlignment
Determina o alinhamento da imagem em um objeto Figura. As opções disponíveis para esta propriedade estão
descritas na tabela a seguir.
Opções disponíveis para a propriedade PictureAlignment
OPÇÃO DESCRIÇÃO
0 - rv2PicTopLeft Alinha a imagem no topo esquerdo do objeto

1 - rv2PicTopRight Alinha a imagem no topo direito do objeto

2 - rv2PicCenter Alinha a imagem no centro do objeto (padrão)

3 - rv2PicBottomLeft Alinha a imagem à esquerda do objeto

4 - rv2PicBottomRight Alinha a imagem à direita do objeto

[Link].1.7 SizeMode
Especifica o tamanho de um objeto Figura. As opções disponíveis para esta propriedade estão descritas na tabela
a seguir.
Opções disponíveis para a propriedade SizeMode
OPÇÃO DESCRIÇÃO
0 - rv2Clip Mostra um objeto Figura no tamanho atual (padrão)

1 - rv2Stretch Ajusta um objeto Figura de acordo com a área

2 - rv2Zoom Ajusta a altura ou a largura da imagem de um objeto

Figura dentro da área especificada, sem distorcê-la

[Link] Linha
Esta seção contém informações sobre propriedades do objeto Linha do Relatório de Seção (SectionReportLine). Este
objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Linha do Relatório de Seção (SectionReportLine).

[Link].1.1 AnchorBottom
Indica se a Linha é ancorada na base da Seção que a contém (Verdadeiro) ou não (Falso, padrão).

[Link].1.2 LineColor
Especifica a cor da linha de um objeto Linha. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).

[Link].1.3 LineStyle
Esta propriedade determina o estilo da linha de um objeto Linha. As opções disponíveis para esta propriedade
estão descritas na tabela a seguir.
Opções disponíveis para a propriedade LineStyle
OPÇÃO DESCRIÇÃO
0 - rv2NoBorder A Linha permanece transparente

1 - rv2Solid A Linha aparece sólida (padrão)

2 - rv2Dashed A Linha aparece tracejada

3 - rv2Dot A Linha aparece pontilhada

4 - rv2DashDot A Linha aparece com um padrão de traço e ponto

5 - rv2DashDotDot A Linha aparece com um padrão de traço, ponto e ponto

6 - rv2Double A Linha aparece com o dobro da largura indicada na

propriedade LineWeight

Visualização 251
[Link].1.4 LineWeight
Especifica a largura da linha de um objeto Linha. Configurando a largura para 1 (um), a linha do objeto é expandida
em até 15 pontos. Configurando a largura para 2 (dois), a linha é expandida em até 30 pontos, e assim por diante.
Quanto maior o número configurado na propriedade, maior a largura do objeto. O valor padrão desta propriedade é
1 (um).

[Link] Quebra de Página

Esta seção contém informações sobre propriedades do objeto Quebra de Página do Relatório de Seção
(SectionReportPageBreak). Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Quebra de Página do Relatório de Seção
(SectionReportPageBreak).

[Link].1.1 Top
Especifica a posição vertical da Quebra de Página.

[Link] Texto
Esta seção contém informações sobre propriedades do objeto Texto do Relatório de Seção (SectionReportText). Este
objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Texto do Relatório de Seção (SectionReportText).

[Link].1.1 Alignment
Determina o alinhamento do texto neste objeto Texto. Os valores possíveis para esta propriedade são 0 - rv2Left:
Alinhamento de texto à esquerda (padrão), 1 - rv2Center: Alinhamento de texto ao centro, 2 - rv2Right: Alinhamento
de texto à direita ou 3 - rv2Justify: Alinhamento de texto justificado.

[Link].1.2 Angle
Indica o ângulo de inclinação do texto no objeto Texto. O valor padrão desta propriedade é 0 (zero).

[Link].1.3 BackOpacity
Define se o fundo deste objeto é opaco ou não. Os valores possíveis para esta propriedade são 0 - rv2Opaque:
Fundo opaco ou 1 - rv2Transparent: Transparente (padrão).

[Link].1.4 CharacterSpacing
Indica o espaçamento entre caracteres deste objeto, em pontos. O valor padrão desta propriedade é 0 (zero).

[Link].1.5 Font
Esta propriedade determina a fonte do texto no objeto Texto. O valor padrão desta propriedade é uma String
vazia. Esta propriedade não pode ser utilizada em scripts ou em Associações e é configurada somente via Elipse E3
Studio. Consulte o tópico Fonte para mais informações sobre as sub-propriedades desta propriedade.

[Link].1.6 Hyperlink
Esta propriedade determina o link que é atribuído ao texto do objeto Texto.

[Link].1.7 LineSpacing
Indica o espaçamento entre linhas deste objeto, em pontos. O valor padrão desta propriedade é 0 (zero).

[Link].1.8 Multiline
Esta propriedade indica se o texto de um objeto Texto tem múltiplas linhas (Verdadeiro) ou se é uma caixa de texto
simples (Falso). Este comportamento pode ser visualizado quando um Elipse E3 Viewer está em execução. O valor

252 Visualização
padrão desta propriedade é Verdadeiro.

[Link].1.9 RightToLeft
Indica se o texto do objeto Texto é alinhado da direita para a esquerda (Falso, padrão) ou da esquerda para a
direita (Verdadeiro).

[Link].1.10 ShrinkToFit
Indica se a fonte do texto do objeto Texto pode diminuir para se ajustar ao conteúdo (Falso, padrão) ou não pode
diminuir (Verdadeiro).

[Link].1.11 Text
Determina o texto que é atribuído ao objeto Texto.

[Link].1.12 VerticalAlignment
Determina o alinhamento vertical do objeto Texto. Os valores possíveis para esta propriedade são 0 - rv2Top:
Alinhamento pelo topo (padrão), 1 - rv2Middle: Alinhamento pelo centro ou 2 - rv2Bottom: Alinhamento pela base.

[Link].1.13 WrapMode
Define o modo de quebra de texto mostrado neste objeto Texto. Os valores possíveis para esta propriedade são 0
- rv2NoWrap: Sem quebra de texto, 1 - rv2WordWrap: A quebra de texto leva em conta palavras inteiras (padrão) ou
2 - rv2CharWrap: A quebra de texto leva em conta apenas caracteres.

4.8.8 Seção
Esta seção contém informações sobre propriedades comuns do objeto Seção do Relatório de Seção
(SectionReportSectionBase). Este objeto não possui eventos nem métodos associados.

[Link] Propriedades Comuns

Esta seção contém informações sobre as propriedades comuns do objeto Seção do Relatório de Seção
(SectionReportSectionBase).

[Link].1 BackOpacity
Define se o fundo de uma Seção é opaco ou não. Os valores possíveis para esta propriedade são 0 - rv2Opaque:
Fundo opaco ou 1 - rv2Transparent: Transparente (padrão).

[Link].2 CanGrow
Indica se uma Seção pode aumentar a altura com base no conteúdo. O valor padrão desta propriedade é
Verdadeiro.

[Link].3 CanShrink
Indica se uma Seção pode diminuir a altura com base no conteúdo. O valor padrão desta propriedade é Falso.

[Link].4 Height
Determina a altura de uma Seção da página do Relatório de Seção. O valor padrão desta propriedade é 0.635.

[Link].5 Visible
Habilita ou desabilita a visibilidade de uma Seção em um Relatório de Seção. O valor padrão desta propriedade é
Verdadeiro.

[Link] Detail
Esta seção contém informações sobre propriedades de uma Seção do tipo Detail de um Relatório de Seção. Este
objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto do tipo Detail de um Relatório de Seção.

Visualização 253
[Link].1.1 ColumnCount
Determina o número de colunas em uma Seção do tipo Detail de um Relatório de Seção. A largura de cada coluna
deve ser igual à área imprimível do Relatório de Seção, dividida pelo número de colunas. O valor padrão desta
propriedade é 1 (um).

[Link].1.2 ColumnDirection
Determina a direção da impressão das colunas de uma Seção do tipo Detail. As opções disponíveis para esta
propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade ColumnDirection
OPÇÃO DESCRIÇÃO
0 - rv2DownAcross Imprime cada coluna de uma Seção do tipo Detail de
cima para baixo e depois passa para a próxima coluna à
direita (padrão)

1 - rv2AcrossDown Imprime cada coluna de uma Seção do tipo Detail da

direita para a esquerda e assim por diante

O layout é determinado de acordo com a opção configurada, conforme mostrado nas figuras a seguir.

Opção rv2DownAccross

254 Visualização
 Opção rv2AccrossDown

[Link].1.3 ColumnSpacing
Determina o espaçamento de uma coluna em uma Seção do tipo Detail. O valor padrão desta propriedade é 0
(zero).

[Link].1.4 KeepTogether
Indica se uma Seção do tipo Detail deve ser impressa como uma página única. O valor padrão desta propriedade é
Falso.

[Link].1.5 NewColumn
Determina se uma nova quebra de coluna deve iniciar antes ou depois de imprimir uma Seção do tipo Detail. As
opções disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade NewColumn
OPÇÃO DESCRIÇÃO
0 - rv2NoNew Não há quebra de coluna

1 - rv2Before Insere uma quebra de coluna antes de imprimir esta

Seção

3 - rv2After Insere uma quebra de coluna depois de imprimir esta

Seção

4 - rv2BeforeAfter Insere uma quebra de coluna antes e depois de imprimir

esta Seção

[Link].1.6 NewPage
Determina se uma nova quebra de página deve iniciar antes ou depois de imprimir uma Seção do tipo Detail. As
opções disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade NewPage
OPÇÃO DESCRIÇÃO
0 - rv2NoNew Não há quebra de página

1 - rv2Before Insere uma quebra de página antes de imprimir esta

Seção

3 - rv2After Insere uma quebra de página depois de imprimir esta

Seção

Visualização 255
 OPÇÃO DESCRIÇÃO
4 - rv2BeforeAfter Insere uma quebra de página antes e depois de imprimir
esta Seção

[Link].1.7 RepeatToFill
Indica se esta Seção do tipo Detail deve ser impressa para preencher a página se não há dados suficientes. O valor
padrão desta propriedade é Falso.

[Link] Footer
Esta seção contém informações sobre propriedades de uma Seção do tipo Footer de um Relatório de Seção. Este
objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto do tipo Footer de um Relatório de Seção.

[Link].1.1 KeepTogether
Indica se uma Seção do tipo Footer deve ser impressa como uma página única. O valor padrão desta propriedade
é Falso.

[Link].1.2 PrintAtBottom
Indica se esta Seção deve ser impressa na base da página imediatamente antes de qualquer rodapé de página. O
valor padrão desta propriedade é Falso.

[Link] Group Footer

Esta seção contém informações sobre propriedades de uma Seção do tipo Group Footer de um Relatório de Seção.
Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto do tipo Group Footer de um Relatório de Seção.

[Link].1.1 ColumnLayout
Indica se uma Seção do tipo Group Footer deve usar o mesmo layout de coluna da Seção do tipo Detail
correspondente. O valor padrão desta propriedade é Verdadeiro.

[Link].1.2 KeepTogether
Indica se uma Seção do tipo Group Footer deve ser impressa como uma página única. O valor padrão desta
propriedade é Falso.

[Link].1.3 NewColumn
Determina se uma nova quebra de coluna deve iniciar antes ou depois de imprimir uma Seção do tipo Group
Footer. As opções disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade NewColumn
OPÇÃO DESCRIÇÃO
0 - rv2NoNew Não há quebra de coluna

1 - rv2Before Insere uma quebra de coluna antes de imprimir esta

Seção

3 - rv2After Insere uma quebra de coluna depois de imprimir esta

Seção

4 - rv2BeforeAfter Insere uma quebra de coluna antes e depois de imprimir

esta Seção

256 Visualização
[Link].1.4 NewPage
Determina se uma nova quebra de página deve iniciar antes ou depois de imprimir uma Seção do tipo Group
Footer. As opções disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade NewPage
OPÇÃO DESCRIÇÃO
0 - rv2NoNew Não há quebra de página

1 - rv2Before Insere uma quebra de página antes de imprimir esta

Seção

3 - rv2After Insere uma quebra de página depois de imprimir esta

Seção

4 - rv2BeforeAfter Insere uma quebra de página antes e depois de imprimir

esta Seção

[Link].1.5 PrintAtBottom
Indica se esta Seção deve ser impressa na base da página imediatamente antes de qualquer rodapé de página. O
valor padrão desta propriedade é Falso.

[Link] Group Header

Esta seção contém informações sobre propriedades de uma Seção do tipo Group Header de um Relatório de Seção.
Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto do tipo Group Header de um Relatório de Seção.

[Link].1.1 ColumnGroupKeepTogether
Indica se esta Seção e o respectivo rodapé são impresso como um bloco único na mesma coluna. O valor padrão
desta propriedade é Falso.

[Link].1.2 ColumnLayout
Indica se uma Seção do tipo Group Header deve usar o mesmo layout de coluna da Seção do tipo Detail
correspondente. O valor padrão desta propriedade é Verdadeiro.

[Link].1.3 DataField
Configura ou retorna o dado associado à Seção do tipo Group Header. Este dado associado pode ser um campo
da tabela no banco de dados fornecido pelo objeto Consulta, uma expressão matemática com campos da Consulta
ou um Tag ou propriedade do Elipse E3. Neste caso, o valor atual da variável é mostrado ao realizar a impressão. O
valor padrão desta propriedade é uma String vazia.

NOTA
O servidor deve estar em execução para que o valor da variável possa ser capturado.

[Link].1.4 GroupKeepTogether
Indica se esta Seção e o respectivo rodapé são impressos como um bloco único na mesma página. O valor padrão
desta propriedade é Falso.

[Link].1.5 KeepTogether
Indica se uma Seção do tipo Group Header deve ser impressa como uma página única. O valor padrão desta
propriedade é Falso.

[Link].1.6 NewColumn
Determina se uma nova quebra de coluna deve iniciar antes ou depois de imprimir uma Seção do tipo Group
Header. As opções disponíveis para esta propriedade estão descritas na tabela a seguir.

Visualização 257
 Opções disponíveis para a propriedade NewColumn
OPÇÃO DESCRIÇÃO
0 - rv2NoNew Não há quebra de coluna

1 - rv2Before Insere uma quebra de coluna antes de imprimir esta

Seção

3 - rv2After Insere uma quebra de coluna depois de imprimir esta

Seção

4 - rv2BeforeAfter Insere uma quebra de coluna antes e depois de imprimir

esta Seção

[Link].1.7 NewPage
Determina se uma nova quebra de página deve iniciar antes ou depois de imprimir uma Seção do tipo Group
Header. As opções disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade NewPage
OPÇÃO DESCRIÇÃO
0 - rv2NoNew Não há quebra de página

1 - rv2Before Insere uma quebra de página antes de imprimir esta

Seção

3 - rv2After Insere uma quebra de página depois de imprimir esta

Seção

4 - rv2BeforeAfter Insere uma quebra de página antes e depois de imprimir

esta Seção

[Link].1.8 RepeatStyle
Determina se uma Seção Group Header é impressa novamente depois de ser associada à uma Seção Detail
quando há múltiplas páginas, colunas ou quebras de páginas em um Relatório de Seção. As opções disponíveis para
esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade RepeatStyle
OPÇÃO DESCRIÇÃO
0 - rv2NoRepeat Não há reimpressão do grupo de cabeçalho (padrão)

1 - rv2OnPage Imprime o grupo de cabeçalhos no topo da página

conforme as especificações da Seção Detail

2 - rv2OnColumn Imprime o grupo de cabeçalhos no topo da coluna da

página do Relatório de Seção conforme as
especificações da Seção Detail

3 - rv2RepeatAll Imprime o grupo de cabeçalhos e os demais objetos no

topo da página do Relatório de Seção conforme as
especificações da Seção Detail

4 - rv2OnPageIncludeNoDetail Imprime o grupo de cabeçalhos no topo da página sem

seguir as especificações da Seção Detail

[Link].1.9 UnderlayNext
Indica se esta Seção deve imprimir por baixo da próxima Seção.

[Link] Header
Esta seção contém informações sobre propriedades de uma Seção do tipo Header de um Relatório de Seção. Este
objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto do tipo Header de um Relatório de Seção.

258 Visualização
[Link].1.1 NewPage
Determina se uma nova quebra de página deve iniciar antes ou depois de imprimir uma Seção do tipo Header. As
opções disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade NewPage
OPÇÃO DESCRIÇÃO
0 - rv2NoNew Não há quebra de página

1 - rv2Before Insere uma quebra de página antes de imprimir esta

Seção

3 - rv2After Insere uma quebra de página depois de imprimir esta

Seção

4 - rv2BeforeAfter Insere uma quebra de página antes e depois de imprimir

esta Seção

4.9 TrendAnalysis
Esta seção contém informações sobre métodos e propriedades do objeto TrendAnalysis (ITrendAnalysisObject). 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 TrendAnalysis (TrendAnalysisObject).

[Link] AddDisplay
AddDisplay([Title], [DisplayPosition])
Adiciona uma Exibição nova no TrendAnalysis. O parâmetro opcional Title indica o título da Exibição. Se omitido, utiliza
um título padrão incremental. O parâmetro opcional DisplayPosition indica a posição desta Exibição em relação à
Exibição selecionada, caso o TrendAnalysis esteja aberto, ou em relação à última Exibição adicionada, caso o
TrendAnalysis esteja fechado. Os valores possíveis para este parâmetro são -1: tadpDefault (menos um, padrão), 0:
tadpLeft (à esquerda), 1: tadpRight (à direita), 2: tadpTop (acima) ou 3: tadpBottom (abaixo). O valor padrão (-1,
menos um) usa um cálculo interno para definir a posição da Exibição. Este método retorna Verdadeiro se a Exibição
foi adicionada com sucesso ou Falso caso contrário. O código a seguir contém um exemplo de uso deste método.
Sub CommandButton1_Click()
Set TA = [Link]("Popup")
[Link] "Dados1.TagDemo1"
[Link]
[Link] "Dados1.TagDemo2"
[Link] "TelaDireita", 1
[Link]
[Link] "Dados1.TagDemo3"
[Link] "TelaEmbaixo", 3
[Link]
End Sub

[Link] AddPen
AddPen(PenPath, [ErrorDetails])
Adiciona uma Pena na última área de plotagem adicionada. O parâmetro PenPath corresponde ao caminho de um Tag
no Elipse E3. O parâmetro opcional de retorno ErrorDetails contém uma String detalhando o erro desta operação.
Este método retorna Verdadeiro se a Pena foi adicionada com sucesso ou Falso caso contrário. Consulte o método
AddDisplay para um exemplo deste método.

[Link] AddPlotArea
AddPlotArea()
Adiciona uma área de plotagem na Exibição selecionada, caso o TrendAnalysis esteja aberto, ou na última Exibição,
caso o TrendAnalysis esteja fechado. Este método retorna Verdadeiro se a área de plotagem foi adicionada com
sucesso ou Falso caso contrário. Consulte o método AddDisplay para um exemplo deste método.

Visualização 259
[Link] CenterWindow
CenterWindow()
Centraliza a janela do TrendAnalysis. Se a janela já está aberta, é centralizada imediatamente. Consulte o método
SetWindowPlacement para mais informações sobre o posicionamento de janelas TrendAnalysis.

[Link] Close
Close()
Fecha a janela do TrendAnalysis.

[Link] Load
Load(Configuration, [ConfigStatus], [ErrorDetails])
Carrega uma configuração salva pelo método Save no parâmetro Configuration. Este método retorna Verdadeiro se a
operação de carregamento foi bem-sucedida ou Falso caso contrário. O parâmetro opcional de retorno ConfigStatus
indica o resultado da operação de carregamento. Se o método retorna Verdadeiro, ou seja, a operação foi bem-
sucedida, este parâmetro retorna o valor 0: A configuração foi carregada com sucesso. Se o método retorna Falso, ou
seja, a operação não foi bem-sucedida, este parâmetro retorna os valores 1: A configuração não carregou
corretamente, 2: O conteúdo da configuração é inválido ou 3: Esta configuração requer uma versão mais recente. O
parâmetro opcional de retorno ErrorDetails contém uma String detalhando o erro da operação de carregamento. O
código a seguir contém um exemplo de utilização deste método.
Set TA = [Link]("TrendAnalysis")
Dim loadResult, errorMsg, errorDetails

loadResult = [Link]([Link]("TextBox3").Value, ConfigStatus, errorDetails)

If loadResult = False Then
If ConfigStatus <> 0 Then
Select Case ConfigStatus
Case 1
errorMsg = "Erro (1): A configuração não foi carregada corretamente."
Case 2
errorMsg = "Erro (2): O conteúdo da configuração é inválido."
Case 3
errorMsg = "Erro (3): Esta configuração requer uma versão mais recente"
End Select
errorMsg = errorMsg & vbCrLf & "Detalhes: " & errorDetails
MsgBox errorMsg
End If
Else
[Link]
End If

NOTA
Utilizar o método Show em um objeto TrendAnalysis cujo carregamento da configuração não tenha sido bem-
sucedido apenas mostra uma janela em branco.

[Link] Save
Save()
Salva e retorna a configuração do objeto TrendAnalysis. O valor de retorno deste método pode ser usado no método
Load para recarregar esta configuração em usos subsequentes deste objeto.

[Link] SetWindowPlacement
SetWindowPlacement([PosX], [PosY], [SizeX], [SizeY])
Informa a posição e o tamanho da janela do TrendAnalysis. Se nenhuma posição ou tamanho é especificado, o
posicionamento desta janela obedece o modo automático:
· O tamanho inicial é o mínimo e, nas vezes subsequentes em que a janela é aberta, este tamanho inicial é
armazenado e reutilizado
· A posição inicial é centralizada e, nas vezes subsequentes em que a janela é aberta, esta posição inicial é
armazenada e reutilizada

260 Visualização
NOTA
A informação de posição e tamanho da janela é salva no Registro do Windows, por usuário, e é específica de cada
janela do TrendAnalysis.

Este método pode ser chamado com o TrendAnalysis visível ou não. Se a janela já está visível, é movida e
redimensionada imediatamente. Do contrário, a última posição e tamanho são armazenados para serem utilizados
quando a janela é novamente aberta.
Todos os parâmetros são opcionais, mas só são válidos se informados aos pares, PosX com PosY e SizeX com SizeY.
Caso somente os parâmetros de posição sejam informados, PosX e PosY, o tamanho não é afetado. Da mesma forma,
se apenas os parâmetros de tamanho são informados, SizeX e SizeY, a posição não é afetada.
Resumo do comportamento da janela TrendAnalysis
MODO AUTOMÁTICO POSIÇÃO NÃO TAMANHO NÃO
ESPECIFICADA ESPECIFICADO
Tamanho Mínimo ou último -- Mínimo
armazenado

Posição Centralizada ou última Centralizada --

armazenada

[Link] Show
Show()
Mostra a janela do TrendAnalysis, se não está visível. Se a janela já existe, apenas recebe o foco.

4.9.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto TrendAnalysis (TrendAnalysisObject).

[Link] IsOpened
Informa se existe uma janela do TrendAnalysis aberta ou não. Esta propriedade é somente de leitura.

[Link] Title
Retorna o título da janela do TrendAnalysis. Esta propriedade é somente de leitura.

Visualização 261
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:
· Alarmes
· Banco de Dados
· Coleção de Campos de Usuário de Alarmes
· Drivers
· Fórmulas
· Históricos
· Informações do Servidor
· Objetos em Tempo de Configuração
· Objetos em Tempo de Execução do Servidor
· Servidor de Dados
· Storage

5.1 Propriedades Comuns

Esta seção contém informações sobre as propriedades comuns a todos os objetos de Servidor.

5.1.1 IsAlarmArea
Habilita ou desabilita a funcionalidade de Área de Alarme para os objetos de Servidor. Esta propriedade não está
disponível nos objetos Área de Alarmes, Campo do Histórico, Campo do Storage, Coleção de Campos do Histórico
(objeto Fields), Coleção de Campos do Storage (objeto Fields), Fonte de Alarmes e Servidor de Alarmes. O valor
padrão desta propriedade é Falso. Ao habilitar esta propriedade, o objeto passa a contar com as mesmas
propriedades de uma Área de Alarme.

5.1.2 Propriedades Comuns a Objetos de Servidor como Áreas de

Alarme
Esta seção contém informações sobre propriedades comuns a objetos de servidor que se comportam como Áreas de
Alarme.

[Link] ActiveAlarms
Determina o número de Alarmes ativos em um objeto. Esta propriedade é somente de leitura.

[Link] ActiveCritAlarms
Indica o número de Alarmes ativos com severidade Crítica em um objeto. Esta propriedade é somente de leitura.

[Link] ActiveCritNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Crítica em um objeto. Esta propriedade é somente
de leitura.

[Link] ActiveHighAlarms
Indica o número de Alarmes ativos com severidade Alta em um objeto. Esta propriedade é somente de leitura.

[Link] ActiveHighNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Alta em um objeto. Esta propriedade é somente de
leitura.

262 Objetos de Servidor

[Link] ActiveLowAlarms
Indica o número de Alarmes ativos com severidade Baixa em um objeto. Esta propriedade é somente de leitura.

[Link] ActiveLowNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Baixa em um objeto. Esta propriedade é somente de
leitura.

[Link] ActiveMedAlarms
Indica o número de Alarmes ativos com severidade Média em um objeto. Esta propriedade é somente de leitura.

[Link] ActiveMedNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Média em um objeto. Esta propriedade é somente
de leitura.

[Link] ActiveNACKAlarms
Indica o número de Alarmes não reconhecidos em um objeto. Esta propriedade é somente de leitura.

[Link] Alarm
Indica a existência de Alarmes ativos em um objeto. Se o valor desta opção é Verdadeiro, existe pelo menos um
Alarme ativo no objeto e a propriedade ActiveAlarms realiza a leitura no servidor, indicando a quantidade de
Alarmes ativos. Caso contrário, a propriedade ActiveNACKAlarms realiza a leitura dos Alarmes sem reconhecimento.
Esta propriedade é somente de leitura.

[Link] AlarmVerify
Habilita a verificação de todos os Alarmes em um objeto. Depois de habilitada esta propriedade, se a propriedade
ActiveAlarms possuir um 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.

[Link] InactiveCritNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Crítica em um objeto. Esta propriedade é
somente de leitura.

[Link] InactiveHighNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Alta em um objeto. Esta propriedade é
somente de leitura.

[Link] InactiveLowNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Baixa em um objeto. Esta propriedade é
somente de leitura.

[Link] InactiveMedNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Média em um objeto. Esta propriedade é
somente de leitura.

[Link] InactiveNACKAlarms
Determina o número total de Alarmes inativos e não reconhecidos em um objeto. Esta propriedade é somente de
leitura.

[Link] OutOfServiceAlarms
Determina o número total de Alarmes suprimidos usando o tipo Fora de Serviço (Out-of-Service). Esta propriedade é
somente de leitura.

Objetos de Servidor 263

[Link] ShelvedAlarms
Determina o número total de Alarmes ou Eventos suprimidos usando o tipo Arquivamento em um objeto. Esta
propriedade é somente de leitura.

[Link] SuppressedAlarms
Determina o número total de Alarmes suprimidos em um objeto, tanto usando o tipo Arquivamento quanto usando
o tipo Condição. Esta propriedade é somente de leitura.

[Link] SuppressedByDesignAlarms
Determina o número total de Alarmes suprimidos usando o tipo Condição em um objeto. Esta propriedade é
somente de leitura.

[Link] UserFields
Retorna um objeto que é uma coleção de Campos de Usuário de Alarmes de um objeto de Servidor. Consulte o
tópico Coleção de Campos de Usuário de Alarmes para maiores informações sobre a coleção de objetos retornados
por esta propriedade. Esta propriedade é somente de leitura.

5.2 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.2.1 Áreas de Alarme

Esta seção contém informações sobre propriedades do objeto Área de Alarme (Area). Este objeto não possui eventos
nem métodos associados.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Área de Alarme (Area).

[Link].1 ActiveAlarms
Determina o número de Alarmes ativos em uma Área. Esta propriedade é somente de leitura.

[Link].2 ActiveCritAlarms
Indica o número de Alarmes ativos com severidade Crítica em uma Área. Esta propriedade é somente de leitura.

[Link].3 ActiveCritNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Crítica em uma Área. Esta propriedade é somente
de leitura.

[Link].4 ActiveHighAlarms
Indica o número de Alarmes ativos com severidade Alta em uma Área. Esta propriedade é somente de leitura.

[Link].5 ActiveHighNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Alta em uma Área. Esta propriedade é somente de
leitura.

[Link].6 ActiveLowAlarms
Indica o número de Alarmes ativos com severidade Baixa em uma Área. Esta propriedade é somente de leitura.

[Link].7 ActiveLowNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Baixa em uma Área. Esta propriedade é somente de
leitura.

264 Objetos de Servidor

[Link].8 ActiveMedAlarms
Indica o número de Alarmes ativos com severidade Média em uma Área. Esta propriedade é somente de leitura.

[Link].9 ActiveMedNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Média em uma Área. Esta propriedade é somente de
leitura.

[Link].10 ActiveNACKAlarms
Indica o número de Alarmes sem reconhecimento em uma Área. Esta propriedade é somente de leitura.

[Link].11 Alarm
Indica a existência de Alarmes ativos dentro de uma Área. Se o valor desta opção é Verdadeiro, existe ao menos um
Alarme ativo dentro da Área, e a propriedade ActiveAlarms realiza 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.

[Link].12 AlarmVerify
Habilita a verificação de todos os Alarmes em uma Área. Depois de habilitada esta propriedade, se a propriedade
ActiveAlarms possui um valor maior que 0 (zero), o sistema verifica tanto os Alarmes ativos quanto aqueles 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.

[Link].13 InactiveCritNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Crítica em uma Área. Esta propriedade é
somente de leitura.

[Link].14 InactiveHighNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Alta em uma Área. Esta propriedade é
somente de leitura.

[Link].15 InactiveLowNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Baixa em uma Área. Esta propriedade é
somente de leitura.

[Link].16 InactiveMedNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Média em uma Área. Esta propriedade é
somente de leitura.

[Link].17 InactiveNACKAlarms
Determina o número total de Alarmes inativos e não reconhecidos em uma Área. Esta propriedade é somente de
leitura.

[Link].18 OutOfServiceAlarms
Determina o número total de Alarmes suprimidos em uma Área usando o tipo Fora de Serviço (Out-of-Service). Esta
propriedade é somente de leitura.

[Link].19 ShelvedAlarms
Determina o número total de Alarmes ou Eventos suprimidos usando o tipo Arquivamento em uma Área. Esta
propriedade é somente de leitura.

[Link].20 SuppressedAlarms
Determina o número total de Alarmes suprimidos em uma Área, tanto usando o tipo Arquivamento quanto usando
o tipo Condição. Esta propriedade é somente de leitura.

Objetos de Servidor 265

[Link].21 SuppressedByDesignAlarms
Determina o número total de Alarmes suprimidos usando o tipo Condição em uma Área. Esta propriedade é
somente de leitura.

[Link].22 UserFields
Retorna um objeto que é uma coleção de Campos de Usuário de Alarmes de uma Área de Alarme. Consulte o
tópico Coleção de Campos de Usuário de Alarmes para mais informações sobre a coleção de objetos retornados
por esta propriedade. Esta propriedade é somente de leitura.

5.2.2 Configuração de Alarmes

O objeto Configuração de Alarmes (AlarmConfig) não possui eventos, métodos ou propriedades específicos
associados, somente métodos e propriedades gerais. Estes podem ser visualizados nas seções Eventos, Métodos e
Propriedades Gerais dos Objetos.

5.2.3 Fontes de Alarme

Esta seção contém informações sobre métodos e propriedades comuns ao objeto Fonte de Alarme. Este objeto não
possui eventos comuns associados.

NOTA
Quando um objeto Fonte de Alarme é desabilitado ou desativado, as propriedades ActiveNACKAlarm, Alarm,
CurrentSeverity, CurrentSubConditionName, FormattedValue, RawAlarm e Value assumem os valores padrão,
indicando que a Fonte de Alarme não está vinculada a uma mensagem de alarme ativa. Neste caso, os valores das
propriedades Alarm e ActiveNACKAlarm são propagados para os contadores das Áreas superiores. Para que as
propriedades citadas recebam um valor diferente do padrão, é necessário que as seguintes condições estejam
presentes:
· A Fonte de Alarme deve estar habilitada e ativada
· As Áreas de Alarme, e todos os objetos hierarquicamente superiores, devem estar habilitadas e ativadas
· O Servidor de Alarmes deve estar ativado

[Link] Métodos Comuns

Esta seção contém informações sobre os métodos comuns aos objetos Fontes de Alarme.

[Link].1 Ack
Ack([ActorID])
Executa o reconhecimento de um Alarme configurado no objeto Fonte de Alarmes. Este 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 omitido, assume o logon do usuário do Elipse E3
Viewer, "Anonymous" se não há usuário logado ou "System" se a chamada do método originou-se no servidor.

[Link].2 GetAlarm
GetAlarm()
Retorna um objeto que permite o acesso às configurações específicas de cada tipo de Alarme. Este objeto permite
verificar ou modificar em tempo de execução as propriedades de um determinado Alarme. Dependendo do tipo de
Alarme, este método retorna um objeto com as propriedades descritas nas tabelas a seguir.
Propriedades de um objeto Alarme Analógico
PROPRIEDADE DESCRIÇÃO
ConditionName Nome da condição de alarme

Delay Tempo de atraso para este Alarme, em milissegundos,

tanto na entrada quanto na saída da condição

Hi Habilita ou desabilita a verificação deste Alarme com

nível de severidade Alto

266 Objetos de Servidor

 PROPRIEDADE DESCRIÇÃO
HiAckRequired Indica se há necessidade de reconhecimento para o nível
de severidade Alto deste Alarme

HiHi Habilita ou desabilita a verificação deste Alarme com

nível de severidade Muito Alto

HiHiAckRequired Indica se há necessidade de reconhecimento para o nível

de severidade Muito Alto deste Alarme

HiHiLimit Limite para o nível de severidade Muito Alto deste

Alarme

HiHiMessageText Texto da mensagem para o nível de severidade Muito

Alto deste Alarme

HiHiSeverity Importância do nível de severidade Muito Alto deste

Alarme. Os valores possíveis para esta propriedade são
-2: Crítica, 0: Alta, 1: Média ou 2: Baixa

HiLimit Limite para o nível de severidade Alto deste Alarme

HiMessageText Texto da mensagem para o nível de severidade Alto

deste Alarme

HiSeverity Importância do nível de severidade Alto deste Alarme.

Os valores possíveis para esta propriedade são -2:
Crítica, 0: Alta, 1: Média ou 2: Baixa

LevelDeadBand Banda morta para os limites do nível deste Alarme

LevelReturnMessageText Mensagem de retorno deste Alarme

Lo Habilita ou desabilita a verificação deste Alarme com

nível de severidade Baixo

LoAckRequired Indica se há necessidade de reconhecimento para o nível

de severidade Baixo deste Alarme

LoLimit Limite para o nível de severidade Baixo deste Alarme

LoLo Habilita ou desabilita a verificação deste Alarme com

nível de severidade Muito Baixo

LoLoAckRequired Indica se há necessidade de reconhecimento para o nível

de severidade Muito Baixo deste Alarme

LoLoLimit Limite para o nível de severidade Muito Baixo deste

Alarme

LoLoMessageText Texto da mensagem para o nível de severidade Muito

Baixo deste Alarme

LoLoSeverity Importância do nível de severidade Muito Baixo deste

Alarme. Os valores possíveis para esta propriedade são
-2: Crítica, 0: Alta, 1: Média ou 2: Baixa

LoMessageText Texto da mensagem para o nível de severidade Baixo

deste Alarme

LoSeverity Importância do nível de severidade Baixo deste Alarme.

Os valores possíveis para esta propriedade são -2:
Crítica, 0: Alta, 1: Média ou 2: Baixa

Name Nome deste Alarme

Propriedades de um objeto Alarme Banda Morta

PROPRIEDADE DESCRIÇÃO
ConditionName Nome da condição de alarme

DeadBand Habilita ou desabilita a verificação deste Alarme

Objetos de Servidor 267

 PROPRIEDADE DESCRIÇÃO
DeadBandAckRequired Indica se há necessidade de reconhecimento para este
Alarme

DeadBandLimit Limite para este Alarme

DeadBandMessageText Texto da mensagem deste Alarme

DeadBandReturnMessageText Mensagem de retorno deste Alarme

DeadBandSetPoint Limite de banda morta deste Alarme. Cada vez que o

valor do Tag associado ultrapassa o valor desta
propriedade para mais ou para menos do valor de
DeadBandLimit, este Alarme ocorre

DeadBandSeverity Importância deste Alarme. Os valores possíveis para esta

propriedade são -2: Crítica, 0: Alta, 1: Média ou 2: Baixa

Delay Tempo de atraso para este Alarme, em milissegundos,

tanto na entrada quanto na saída da condição

Name Nome deste Alarme

Propriedades de um objeto Alarme Digital

PROPRIEDADE DESCRIÇÃO
ConditionName Nome da condição de alarme

Delay Tempo de atraso para este Alarme, em milissegundos,

tanto na entrada quanto na saída da condição

Digital Habilita ou desabilita a verificação deste Alarme

DigitalAckRequired Indica se há necessidade de reconhecimento para este

Alarme

DigitalLimit Limite para este Alarme

DigitalMessageText Texto da mensagem deste Alarme

DigitalReturnMessageText Mensagem de retorno deste Alarme

DigitalSeverity Severidade deste Alarme. Os valores possíveis para esta

propriedade são -2: Crítica, 0: Alta, 1: Média ou 2: Baixa

Name Nome deste Alarme

Propriedades de um objeto Alarme Discreto

PROPRIEDADE DESCRIÇÃO
ConditionName Nome da condição de alarme

Delay Tempo de atraso para este Alarme, em milissegundos,

tanto na entrada quanto na saída da condição

DiscreteReturnMessageText Mensagem de retorno deste Alarme

Name Nome deste Alarme

SubConditions Coleção de Subcondições deste Alarme. Consulte a

tabela a seguir para uma descrição das propriedades
disponíveis nos objetos Subcondição desta coleção,
acessíveis utilizando o método Item

268 Objetos de Servidor

 Propriedades de um objeto Subcondição de um Alarme Discreto
PROPRIEDADE DESCRIÇÃO
AckRequired Indica se há necessidade de reconhecimento para esta
Subcondição

Caption Descrição desta Subcondição

Enabled Habilita ou desabilita esta Subcondição

Kind Comportamento desta Subcondição. Os valores

possíveis para esta propriedade são 0: Alarme, 1:
Evento ou 2: Retorno

Limit Valor da Fonte do Alarme para gerar esta Subcondição

Message Mensagem do Evento quando esta Subcondição está

ativa

Name Nome desta Subcondição

Severity Importância desta Subcondição. Os valores possíveis

para esta propriedade são -2: Crítica, 0: Alta, 1: Média
ou 2: Baixa

Propriedades de um objeto Alarme Taxa de Variação

PROPRIEDADE DESCRIÇÃO
ConditionName Nome da condição de alarme

Delay Tempo de atraso para este Alarme, em milissegundos,

tanto na entrada quanto na saída da condição

Name Nome deste Alarme

ROC Habilita ou desabilita a verificação deste Alarme

ROCAckRequired Indica se há necessidade de reconhecimento para este

tipo de Alarme

ROCLimit Limite para este Alarme. Para que este Alarme ocorra,
basta que o valor do Tag associado ultrapasse este
valor em um segundo

ROCMessageText Texto da mensagem deste Alarme

ROCReturnMessageText Mensagem de retorno deste Alarme

ROCSeverity Importância deste Alarme. Os valores possíveis para esta

propriedade são -2: Crítica, 0: Alta, 1: Média ou 2: Baixa

O código a seguir contém um exemplo de uso deste método.

Sub Botao1_Click()
'Clicar neste Botão muda o nível
'de severidade Baixo de um Alarme Analógico
Set alm = [Link]("Conf1.Area1.Analog1")_
.GetAlarm()
[Link] = 10.2
End Sub

NOTA
As propriedades relativas a cada tipo de Alarme podem ser acessadas diretamente por scripts e Associações, bem
como visualizadas na Lista de Propriedades do objeto, portanto não é mais obrigatória a edição via este método.

Objetos de Servidor 269

[Link].3 RemoveFromService
RemoveFromService(Reason, [ActorID])
Suprime uma Fonte de Alarme usando o tipo Fora de Serviço (Out-of-Service). O parâmetro Reason indica o motivo
para a supressão deste Alarme ou Evento. O parâmetro ActorID é opcional e indica o nome do operador que suprimiu
esta Fonte de Alarme. Este método retorna Verdadeiro se a supressão foi bem-sucedida ou Falso se a supressão
falhou.

[Link].4 ReturnToService
ReturnToService([ActorID])
Remove uma Fonte de Alarme da supressão usando o tipo Fora de Serviço (Out-of-Service). O parâmetro ActorID é
opcional e indica o nome do operador que removeu esta Fonte de Alarme da supressão. Este método retorna
Verdadeiro se a remoção foi bem-sucedida ou Falso se a remoção falhou.

[Link].5 Shelve
Shelve(Duration, Reason, [ActorID])
Arquiva somente o Alarme ou Evento da respectiva Fonte de Alarme. O parâmetro Duration indica o tempo que este
Alarme ou Evento deve permanecer arquivado. O parâmetro Reason indica o motivo para o arquivamento deste
Alarme ou Evento. O parâmetro ActorID indica o usuário responsável pelo arquivamento. Este parâmetro é opcional e,
se omitido, assume o logon do usuário do Elipse E3 Viewer, "Anonymous" se não há usuário logado ou "System" se a
chamada do método originou-se no servidor.

[Link].6 Unshelve
Unshelve([ActorID])
Desarquiva somente o Alarme ou Evento da respectiva Fonte de Alarme. O parâmetro ActorID indica o usuário
responsável pelo arquivamento. Este parâmetro é opcional e, se omitido, assume o logon do usuário do Elipse E3
Viewer, "Anonymous" se não há usuário logado ou "System" se a chamada do método originou-se no servidor.

[Link] Propriedades Comuns

Esta seção contém informações sobre as propriedades comuns aos objetos Fonte de Alarme.

[Link].1 ActiveNACKAlarm
Indica se uma Fonte de Alarme foi ou não reconhecida desde a última ativação. Esta propriedade é somente de
leitura. O valor padrão desta propriedade é Falso.

[Link].2 Alarm
Indica se há Alarmes ativos em uma Fonte de Alarme ou não. Esta propriedade é somente de leitura. O valor padrão
desta propriedade é Falso.

[Link].3 AlarmVerify
Habilita ou não a verificação de uma Fonte de Alarme, ou seja, a geração do Alarme.

[Link].4 AreaNameOverride
Determina um nome alternativo para a Área que contém uma Fonte de Alarme. O valor padrão desta propriedade é
uma String vazia.

NOTAS
· Quando esta propriedade está vazia, o nome da Fonte de Alarme é composto dos nomes dos objetos Área
hierarquicamente superiores.
· Esta propriedade, mesmo quando preenchida, não influencia nos contadores da Áreas de Alarme
hierarquicamente superiores, que continuam contando os Alarmes desta Fonte de Alarme.
· Se esta propriedade é alterada em tempo de execução, o novo valor só entra em vigor quando ocorre o próximo
Alarme nesta Fonte de Alarme.

270 Objetos de Servidor

[Link].5 ConditionName
Especifica o nome da condição de Alarme. Os valores possíveis para esta propriedade são BandaMorta: Fonte de
Alarme do tipo Banda Morta, Digital: Fonte de Alarme do tipo Digital, Discreto: Fonte de Alarme do tipo Discreto,
Nível: Fonte de Alarme do tipo Analógico ou TaxaDeVariação: Fonte de Alarme do tipo Taxa de Variação. Esta
propriedade é somente de leitura.

[Link].6 CurrentSeverity
Indica a última severidade do Alarme ativo. Os valores possíveis para esta propriedade são -2: Crítica, 0: Alta, 1:
Média ou 2: Baixa. Esta propriedade é somente de leitura. O valor padrão desta propriedade é -1 (menos um), ou
seja, a Fonte de Alarme não está ativa.

[Link].7 CurrentSubConditionName
Determina o nome da última condição de alarme ativa. Esta propriedade é somente de leitura. As opções
disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade CurrentSubConditionName
OPÇÃO DESCRIÇÃO
LOLO Alarme Analógico na faixa Muito Baixa

LO Alarme Analógico na faixa Baixa

HI Alarme Analógico na faixa Alta

HIHI Alarme Analógico na faixa Muito Alta

BM Alarme de Banda Morta

TV Alarme Taxa de Variação

DIG Alarme Digital

O valor padrão desta propriedade é uma String vazia.

NOTA
Para Fontes de Alarme do tipo Discreto, esta propriedade assume o nome da Subcondição definida pelo usuário, na
aba Discreto das propriedades deste tipo de Alarme.

[Link].8 Delay
Especifica um tempo de atraso para o Alarme, em milissegundos, tanto na entrada quanto na saída da condição.
Quando esta propriedade está em 0 (zero, que é sempre o valor padrão), não é aplicado nenhum atraso. Quando
esta propriedade é diferente de 0 (zero), o Alarme só é ativado ou desativado se permanece na mesma condição por
um tempo maior ou igual ao especificado.

[Link].9 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 propriedade configurada como Falso.

[Link].10 Event
Indica que um Alarme é do tipo Evento, que são Alarmes reconhecidos pelo usuário "System" ao serem ativados.
Portanto, ao ser reconhecido nada acontece, ou seja, não tem efeito algum, assim como não incrementa o número de
Alarmes ativos nem o número de Alarmes não reconhecidos. Esta propriedade não pode ser alterada com o objeto
ativo.

Objetos de Servidor 271

[Link].11 ExcludeSuppressedOnAreaCounters
Quando configurada para Verdadeiro, desconsidera os Alarmes suprimidos usando o tipo Arquivamento ou
usando o tipo Condição de uma Área de Alarme nos contadores gerais de Alarmes. O valor padrão desta
propriedade é Falso.

[Link].12 Format
Esta propriedade especifica um formato para uma Fonte de Alarme e permite mudar a forma como os dados são
apresentados sem mudar o valor existente. Esta propriedade pode ser editada manualmente ou configurada através
da janela de formatação. O 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
TIPO DE DADOS DESCRIÇÃO
Número Saída decimal, científica, hexadecimal, binária ou octal

Texto Textos em geral

Booleano Valores Booleanos

Data e Hora Calendário Gregoriano

[Link].13 FormattedValue
Contém o valor do Alarme definido na propriedade Value e formatado de acordo com a propriedade Format. Esta
propriedade é somente de leitura. O valor padrão desta propriedade é Null.

[Link].14 OutOfService
Indica se uma Fonte de Alarme entrou em supressão usando o tipo Fora de Serviço (Out-of-Service). Esta
propriedade é somente de leitura.

[Link].15 RawAlarm
Indica se o Alarme deve estar ativo, independente da espera. Quando a espera é igual a 0 (zero), o valor desta
propriedade é igual ao valor da propriedade Alarm. Esta propriedade é somente de leitura. O valor padrão desta
propriedade é Falso.

[Link].16 Shelved
Indica se um Alarme ou Evento está arquivado ou não. Esta propriedade é somente de leitura.

NOTA
Um Alarme ou Evento permanece arquivado mesmo que saia do estado ativo.

[Link].17 ShelveMaxDuration
Define o tempo máximo que esta Fonte de Alarme pode permanecer arquivada, em minutos, quando não está ativa.
O valor padrão desta propriedade é 60 (uma hora). Para Fontes de Alarme Discretas ativas, este tempo máximo deve
ser configurado na propriedade ShelveMaxDuration do objeto Subcondição.

[Link].18 Source
Contém a expressão que deve ser avaliada para determinar se o Alarme deve ocorrer ou não.

[Link].19 SuppressCondition
Define a fonte de dados para supressão usando o tipo Arquivamento ou usando o tipo Condição de Alarmes de
uma Fonte de Alarme.

[Link].20 SuppressedAlarmsConfigured
Indica que a Fonte ou Subcondição de Alarme está configurada para permitir a supressão de Alarmes usando o tipo
Arquivamento ou usando o tipo Condição. Esta propriedade é somente de leitura.

272 Objetos de Servidor

[Link].21 SuppressedAsEvent
Define se um Alarme configurado para supressão usando o tipo Arquivamento ou usando o tipo Condição deve
ser tratado como um Evento ou não.

[Link].22 UserFields
Retorna um objeto que é uma coleção de Campos de Usuário de Alarmes de uma Fonte de Alarme. Consulte o
tópico Coleção de Campos de Usuário de Alarmes para mais informações sobre a coleção de objetos retornados
por esta propriedade. Esta propriedade é somente de leitura.

[Link].23 Value
Contém o valor que foi avaliado para determinar se um Alarme ocorre ou não. O valor padrão desta propriedade é
Null.

[Link] Fonte de Alarme Analógico

Esta seção contém informações sobre propriedades do objeto Fonte de Alarme Analógico (AnalogLevelAlarm). Este
objeto não possui eventos nem métodos associados.

NOTA
Quando o valor da propriedade Event, comum a todas as Fontes de Alarme, está configurado para Verdadeiro, as
propriedades HiEvent, HiHiEvent, LoEvent e LoLoEvent não podem ser modificadas, ou seja, todas as
subcondições do alarme se comportam como eventos.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Fonte de Alarme Analógico (AnalogLevelAlarm).

[Link].1.1 Hi
Habilita ou desabilita a verificação de Alarmes do tipo Hi.

[Link].1.2 HiAckRequired
Indica se o Alarme do tipo Hi requer reconhecimento.

[Link].1.3 HiAllowShelving
Indica se um Alarme ou Evento do tipo Hi pode ser arquivado. O valor padrão desta propriedade é Verdadeiro.

[Link].1.4 HiEvent
Define se a subcondição Hi do Alarme deve ser tratada como um Evento. Se a propriedade Event, comum às
Fontes de Alarme, está configurada para Verdadeiro, esta propriedade não pode ser modificada e o valor permanece
sempre em Verdadeiro. Esta propriedade não pode ser alterada com o objeto ativo.

[Link].1.5 HiHi
Habilita ou desabilita a verificação de Alarmes do tipo HiHi.

[Link].1.6 HiHiAckRequired
Indica se o Alarme do tipo HiHi requer reconhecimento.

[Link].1.7 HiHiAllowShelving
Indica se um Alarme ou Evento do tipo HiHi pode ser arquivado. O valor padrão desta propriedade é Verdadeiro.

[Link].1.8 HiHiEvent
Define se a subcondição HiHi do Alarme deve ser tratada como um Evento. Se a propriedade Event, comum às
Fontes de Alarme, está configurada para Verdadeiro, esta propriedade não pode ser modificada e o valor permanece
sempre em Verdadeiro. Esta propriedade não pode ser alterada com o objeto ativo.

Objetos de Servidor 273

[Link].1.9 HiHiLimit
Indica o nível em que o Alarme do tipo HiHi é ativado.

[Link].1.10 HiHiMessageText
Ajusta a mensagem de texto do limite do Alarme do tipo HiHi.

[Link].1.11 HiHiSeverity
Indica o nível de importância do Alarme do tipo HiHi. Os valores possíveis para esta propriedade são -2: Crítica, 0:
Alta, 1: Média ou 2: Baixa.

[Link].1.12 HiHiShelveMaxCount
Define quantas vezes um Alarme ou Evento do tipo HiHi pode ser arquivado. O valor padrão desta propriedade é 0
(zero), ou seja, sem limites para arquivamento.

[Link].1.13 HiHiShelveMaxDuration
Define a duração máxima, em minutos, do arquivamento de um Alarme ou Evento do tipo HiHi. O valor padrão
desta propriedade é 60 (uma hora).

[Link].1.14 HiLimit
Indica o nível em que o Alarme do tipo Hi é ativado.

[Link].1.15 HiMessageText
Ajusta a mensagem de texto do limite do Alarme do tipo Hi.

[Link].1.16 HiSeverity
Indica o nível de importância do Alarme do tipo Hi. Os valores possíveis para esta propriedade são -2: Crítica, 0:
Alta, 1: Média ou 2: Baixa.

[Link].1.17 HiShelveMaxCount
Define quantas vezes um Alarme ou Evento do tipo Hi pode ser arquivado. O valor padrão desta propriedade é 0
(zero), ou seja, sem limites para arquivamento.

[Link].1.18 HiShelveMaxDuration
Define a duração máxima, em minutos, do arquivamento de um Alarme ou Evento do tipo Hi. O valor padrão desta
propriedade é 60 (uma hora).

[Link].1.19 LevelDeadBand
Banda morta para os limites do nível do Alarme.

[Link].1.20 LevelReturnMessageText
Ajusta a mensagem de retorno do nível do Alarme.

[Link].1.21 Lo
Habilita ou desabilita a verificação de Alarmes do tipo Lo.

[Link].1.22 LoAckRequired
Indica se o Alarme do tipo Lo requer reconhecimento.

[Link].1.23 LoAllowShelving
Indica se um Alarme ou Evento do tipo Lo pode ser arquivado. O valor padrão desta propriedade é Verdadeiro.

274 Objetos de Servidor

[Link].1.24 LoEvent
Define se a subcondição Lo do Alarme deve ser tratada como um Evento. Se a propriedade Event, comum às
Fontes de Alarme, está configurada para Verdadeiro, esta propriedade não pode ser modificada e o valor permanece
sempre em Verdadeiro. Esta propriedade não pode ser alterada com o objeto ativo.

[Link].1.25 LoLimit
Indica o nível em que o Alarme do tipo Lo é ativado.

[Link].1.26 LoLo
Habilita ou desabilita a verificação de Alarmes do tipo LoLo.

[Link].1.27 LoLoAckRequired
Indica se o Alarme do tipo LoLo requer reconhecimento.

[Link].1.28 LoLoAllowShelving
Indica se um Alarme ou Evento do tipo LoLo pode ser arquivado. O valor padrão desta propriedade é Verdadeiro.

[Link].1.29 LoLoEvent
Define se a subcondição LoLo do Alarme deve ser tratada como um Evento. Se a propriedade Event, comum às
Fontes de Alarme, está configurada para Verdadeiro, esta propriedade não pode ser modificada e o valor permanece
sempre em Verdadeiro. Esta propriedade não pode ser alterada com o objeto ativo.

[Link].1.30 LoLoLimit
Indica o nível em que o Alarme do tipo LoLo é ativado.

[Link].1.31 LoLoMessageText
Ajusta a mensagem de texto do limite do Alarme do tipo LoLo.

[Link].1.32 LoLoSeverity
Indica o nível de importância do Alarme do tipo LoLo. Os valores possíveis para esta propriedade são -2: Crítica, 0:
Alta, 1: Média ou 2: Baixa.

[Link].1.33 LoLoShelveMaxCount
Define quantas vezes um Alarme ou Evento do tipo LoLo pode ser arquivado. O valor padrão desta propriedade é 0
(zero), ou seja, sem limites para arquivamento.

[Link].1.34 LoLoShelveMaxDuration
Define a duração máxima, em minutos, do arquivamento de um Alarme ou Evento do tipo LoLo. O valor padrão
desta propriedade é 60 (uma hora).

[Link].1.35 LoMessageText
Ajusta a mensagem de texto do limite do Alarme do tipo Lo.

[Link].1.36 LoSeverity
Indica o nível de importância do Alarme do tipo Lo. Os valores possíveis para esta propriedade são -2: Crítica, 0:
Alta, 1: Média ou 2: Baixa.

[Link].1.37 LoShelveMaxCount
Define quantas vezes um Alarme ou Evento do tipo Lo pode ser arquivado. O valor padrão desta propriedade é 0
(zero), ou seja, sem limites para arquivamento.

Objetos de Servidor 275

[Link].1.38 LoShelveMaxDuration
Define a duração máxima, em minutos, do arquivamento de um Alarme ou Evento do tipo Lo. O valor padrão desta
propriedade é 60 (uma hora).

[Link] Fonte de Alarme Banda Morta

Esta seção contém informações sobre propriedades do objeto Fonte de Alarme Banda Morta (DeadBandAlarm). Este
objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Fonte de Alarme Banda Morta (DeadBandAlarm).

[Link].1.1 DeadBand
Habilita ou desabilita a verificação de um Alarme do tipo Banda Morta.

[Link].1.2 DeadBandAckRequired
Necessidade de reconhecimento para o Alarme do tipo Banda Morta.

[Link].1.3 DeadBandAllowShelving
Indica se um Alarme ou Evento do tipo Banda Morta pode ser arquivado. O valor padrão desta propriedade é
Verdadeiro.

[Link].1.4 DeadBandLimit
Limite para o Alarme do tipo Banda Morta.

[Link].1.5 DeadBandMessageText
Texto da mensagem de Alarme do tipo Banda Morta.

[Link].1.6 DeadBandReturnMessageText
Mensagem de retorno de Alarme do tipo Banda Morta.

[Link].1.7 DeadBandSetpoint
Limite de banda morta do Alarme. Cada vez que o valor do Tag associado ultrapassa o valor desta propriedade,
para mais ou para menos do valor de DeadBandLimit, o Alarme ocorre.

[Link].1.8 DeadBandSeverity
Importância do Alarme do tipo Banda Morta. Os valores possíveis para esta propriedade são -2: Crítica, 0: Alta, 1:
Média ou 2: Baixa.

[Link].1.9 DeadBandShelveMaxCount
Define quantas vezes um Alarme ou Evento do tipo Banda Morta pode ser arquivado. O valor padrão desta
propriedade é 0 (zero), ou seja, sem limites para arquivamento.

[Link].1.10 DeadBandShelveMaxDuration
Define a duração máxima, em minutos, do arquivamento de um Alarme ou Evento do tipo Banda Morta. O valor
padrão desta propriedade é 60 (uma hora).

[Link] Fonte de Alarme Digital

Esta seção contém informações sobre propriedades do objeto Fonte de Alarme Digital (DigitalAlarm). Este objeto não
possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Fonte de Alarme Digital (DigitalAlarm).

276 Objetos de Servidor

[Link].1.1 Digital
Habilita ou desabilita a verificação de um Alarme do tipo Digital.

[Link].1.2 DigitalAckRequired
Necessidade de reconhecimento para um Alarme do tipo Digital.

[Link].1.3 DigitalAllowShelving
Indica se um Alarme ou Evento do tipo Digital pode ser arquivado. O valor padrão desta propriedade é
Verdadeiro.

[Link].1.4 DigitalLimit
Limite para um Alarme do tipo Digital.

[Link].1.5 DigitalMessageText
Texto da mensagem de um Alarme do tipo Digital.

[Link].1.6 DigitalReturnMessageText
Mensagem de retorno de um Alarme do tipo Digital.

[Link].1.7 DigitalSeverity
Severidade de um Alarme do tipo Digital. Os valores possíveis para esta propriedade são -2: Crítica, 0: Alta, 1:
Média ou 2: Baixa.

[Link].1.8 DigitalShelveMaxCount
Define quantas vezes um Alarme ou Evento do tipo Digital pode ser arquivado. O valor padrão desta propriedade é
0 (zero), ou seja, sem limites para arquivamento.

[Link].1.9 DigitalShelveMaxDuration
Define a duração máxima, em minutos, do arquivamento de um Alarme ou Evento do tipo Digital. O valor padrão
desta propriedade é 60 (uma hora).

[Link] Fonte de Alarme Discreto

Esta seção contém informações sobre propriedades do objeto Fonte de Alarme Discreto (DiscreteAlarm). Este objeto
não possui eventos nem métodos associados.

NOTA
Quando o valor da propriedade Event, comum a todas as Fontes de Alarme, está configurado para Verdadeiro, a
propriedade Kind dos objetos da coleção de Subcondições da Fonte de Alarme Discreto não pode ser modificada,
ou seja, todas as subcondições do alarme se comportam como eventos.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Fonte de Alarme Discreto (DiscreteAlarm).

[Link].1.1 DiscreteReturnMessageText
Retorna ou modifica a mensagem de retorno de um Alarme do tipo Discreto. Se algum dos objetos da coleção de
Subcondições têm a propriedade Kind configurada para 2 (dois, Retorno), a propriedade Message deste objeto é
utilizada ao invés do valor definido nesta propriedade.

[Link].1.2 SubConditions
Retorna um objeto que é uma coleção das Subcondições de um Alarme do tipo Discreto. Consulte o tópico
Coleção de Subcondições para mais informações sobre a coleção de objetos retornados por esta propriedade. Esta
propriedade é somente de leitura.

Objetos de Servidor 277

[Link].2 Coleção de Subcondições
Esta seção contém informações sobre métodos e propriedades da Coleção de Subcondições
(DiscreteAlarmSubconditions) retornada pela propriedade SubConditions de uma Fonte de Alarme Discreto.

[Link].2.1 Métodos
Esta seção contém informações sobre Coleção de Subcondições (DiscreteAlarmSubconditions) de uma Fonte de
Alarme Discreto.
AddSubCondition
AddSubCondition([Name], [Caption], [Message], [Kind], [AckRequired], [Severity], [Value])
Adiciona um objeto Subcondição à coleção de Subcondições. Este método possui os parâmetros opcionais descritos
na tabela a seguir.
Parâmetros do método AddSubCondition
PARÂMETRO DESCRIÇÃO
Name O nome do objeto. Corresponde à propriedade Name
do objeto Subcondição. Se omitido, a Subcondição é
criada com o nome "Subcondicao". Se o valor passado
neste parâmetro já existe na coleção, é automaticamente
incrementado. Consulte a propriedade geral Name para
mais informações sobre os caracteres permitidos nos
nomes de objetos

Caption A descrição do objeto. Corresponde à propriedade

Caption do objeto Subcondição. Se omitido, a descrição
da Subcondição criada é uma String vazia

Message O texto da mensagem da Subcondição. Corresponde à

propriedade Message do objeto Subcondição. Se
omitido, a mensagem da Subcondição criada é uma
String vazia

Kind O tipo de comportamento desta Subcondição. Os valores

possíveis para este parâmetro são 0: Alarme, 1: Evento
ou 2: Retorno. Corresponde à propriedade Kind do
objeto Subcondição. Se omitido, o comportamento da
Subcondição criada é 0 (zero, Alarme)

AckRequired Indica se esta Subcondição exige reconhecimento.

Corresponde à propriedade AckRequired do objeto
Subcondição. Se omitido, a Subcondição criada exige
reconhecimento

Severity O tipo de severidade desta Subcondição. Os valores

possíveis para este parâmetro são -2: Crítica, 0: Alta, 1:
Média ou 2: Baixa. Corresponde à propriedade Severity
do objeto Subcondição. Se omitido, a severidade da
Subcondição criada é 1 (um, Média)

Value Parâmetro que contém um valor que é avaliado para

determinar se o alarme ocorre ou não. Corresponde à
propriedade Value, comum às Fontes de Alarme. Se
omitido, o valor da Subcondição criada é Null

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 (um), ou o nome do objeto, definido na propriedade Name.

278 Objetos de Servidor

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 (um), ou o nome do objeto, definido na propriedade Name.

[Link].2.2 Propriedades
Esta seção contém informações sobre Coleção de Subcondições (DiscreteAlarmSubconditions) de uma Fonte de
Alarme Discreto.
Count
Retorna o número de objetos filhos, ou itens, de uma coleção de Subcondições. Esta propriedade trabalha em
conjunto com o método Item. Se a coleção não possui objetos filhos, o valor retornado é 0 (zero). Esta propriedade é
somente de leitura.

[Link].2.3 Subcondições
Esta seção contém informações sobre propriedades de objetos do tipo Subcondição (DiscreteAlarmSubcondition)
contidos na coleção retornada pela propriedade SubConditions da Fonte de Alarme Discreto. Este objeto não possui
eventos nem métodos associados.
Propriedades
Esta seção contém informações sobre as propriedades do objeto Subcondição (DiscreteAlarmSubcondition).
AckRequired
Indica se este objeto Subcondição requer reconhecimento.
AllowShelving
Indica se esta Subcondição pode ser arquivada. O valor padrão desta propriedade é Verdadeiro.
Caption
Descrição da Subcondição.
Enabled
Habilita ou desabilita a Subcondição.
Kind
Indica o comportamento da Subcondição. Os valores possíveis para esta propriedade são 0: Alarme (padrão), 1:
Evento ou 2: Retorno. Se a propriedade Event, comum às Fontes de Alarme, está configurada para Verdadeiro, esta
propriedade não pode ser modificada e o valor permanece sempre em 1 (um, Evento). Esta propriedade não pode
ser alterada com o objeto ativo.
Limit
Define o valor da Fonte de Alarme para gerar a Subcondição.
Message
A mensagem do evento quando a Subcondição está ativa. Se a propriedade Kind está configurada como 2 (dois,
Retorno), esta propriedade é considerada como a mensagem de retorno do alarme.
Name
Nome do objeto Subcondição. Este valor não diferencia maiúsculas e minúsculas. Consulte a propriedade geral
Name para mais informações sobre os caracteres permitidos no nome deste objeto.
Severity
O tipo de severidade desta Subcondição. Os valores possíveis para esta propriedade são -2: Crítica, 0: Alta, 1: Média
ou 2: Baixa.
ShelveMaxCount
Define quantas vezes esta Subcondição pode ser arquivada. O valor padrão desta propriedade é 0 (zero), ou seja,
sem limites para arquivamento.
ShelveMaxDuration
Define a duração máxima, em minutos, do arquivamento desta Subcondição, quando este Alarme ou Evento está
ativo. O valor padrão desta propriedade é 60 (uma hora). Quando este Alarme ou Evento não está ativo, a duração
máxima deve ser configurada na propriedade ShelveMaxDuration da Fonte de Alarme.

Objetos de Servidor 279

[Link] Fonte de Alarme Taxa de Variação
Esta seção contém informações sobre propriedades do objeto Fonte de Alarme Taxa de Variação (ROCAlarm). Este
objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Fonte de Alarme Taxa de Variação (ROCAlarm).

[Link].1.1 ROC
Habilita ou desabilita a verificação de um Alarme do tipo Taxa de Variação.

[Link].1.2 ROCAckRequired
Necessidade de reconhecimento para um Alarme do tipo Taxa de Variação.

[Link].1.3 ROCAllowShelving
Indica se um Alarme ou Evento do tipo Taxa de Variação pode ser arquivado. O valor padrão desta propriedade é
Verdadeiro.

[Link].1.4 ROCLimit
Limite para um Alarme do tipo Taxa de Variação. Para que o Alarme ocorra, basta que o valor do Tag associado
ultrapasse este valor em um segundo.

[Link].1.5 ROCMessageText
Texto da mensagem de um Alarme do tipo Taxa de Variação.

[Link].1.6 ROCReturnMessageText
Mensagem de retorno de um Alarme do tipo Taxa de Variação.

[Link].1.7 ROCSeverity
Importância de um Alarme do tipo Taxa de Variação. Os valores possíveis para esta propriedade são -2: Crítica, 0:
Alta, 1: Média ou 2: Baixa.

[Link].1.8 ROCShelveMaxCount
Define quantas vezes um Alarme ou Evento do tipo Taxa de Variação pode ser arquivado. O valor padrão desta
propriedade é 0 (zero), ou seja, sem limites para arquivamento.

[Link].1.9 ROCShelveMaxDuration
Define a duração máxima, em minutos, do arquivamento de um Alarme ou Evento do tipo Taxa de Variação. O valor
padrão desta propriedade é 60 (uma hora).

5.2.4 Servidor de Alarmes

Esta seção contém informações sobre métodos e propriedades do objeto Servidor de Alarmes (AlarmServer). Este
objeto não possui eventos associados.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Servidor de Alarmes (AlarmServer).

[Link].1 AckAllAlarms
AckAllAlarms([ActorID])
Executa o reconhecimento de todos os Alarmes do Servidor, independente da Área. Este 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 omitido, assume o logon do usuário do Elipse E3
Viewer, "Anonymous" se não há usuário logado ou "System" se a chamada do método originou-se no servidor. O
código a seguir contém um exemplo de uso deste método.

280 Objetos de Servidor

 Sub Botao1_Click()
' Ao clicar neste Botão, reconhece todos os Alarmes
[Link]("ServidorAlarmes1")._
AckAllAlarms([Link])
End Sub

[Link].2 AckArea
AckArea(Area, [ActorID])
Executa o reconhecimento dos Alarmes em uma determinada Área. Este 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", e assim por diante. Se o valor deste parâmetro é uma String vazia, este método
tem o mesmo comportamento do método AckAllAlarms. O parâmetro ActorID informa o nome do usuário
responsável pelo reconhecimento dos Alarmes. Este parâmetro é opcional e, se omitido, assume o logon do usuário
do Elipse E3 Viewer, "Anonymous" se não há usuário logado ou "System" se a chamada do método originou-se no
servidor. O código a seguir contém um exemplo de uso deste método.
Sub Botao1_Click()
'Ao clicar neste Botão, reconhece os Alarmes da Area1
[Link]("ServidorAlarmes1").AckArea "Area1", _
[Link]
End Sub

[Link].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.
Cada parâmetro deste método permite especificar o valor do campo de mesmo nome no Evento. Os campos do
Evento são preenchidos de acordo com os parâmetros deste método, descritos na tabela a seguir.
Parâmetros do método LogTrackingEvent
NOME DESCRIÇÃO
Message Parâmetro texto que especifica o conteúdo do campo
Mensagem do Evento. Se omitido, assume uma String
vazia

ActorID Parâmetro texto que especifica o conteúdo do campo

Operador do Evento. Se omitido, assume o logon do
usuário do Elipse E3 Viewer, "Anonymous" se não há
usuário logado ou "System" se a chamada deste método
originou-se no servidor

Area Parâmetro texto que especifica o conteúdo do campo

Área do Evento. Se omitido, assume uma String vazia

Severity Parâmetro numérico que determina a severidade do

Evento. Se omitido, assume o valor 0 (zero), ou seja,
severidade alta

EventTime Especifica a estampa de tempo do Evento. Se omitido,

assume o valor da estampa de tempo do momento da
chamada deste método

Source Parâmetro texto que especifica o conteúdo do campo

Fonte do Evento. Se omitido, assume uma String vazia

EventCategory Parâmetro texto que especifica a categoria do Evento. Se

omitido, assume uma String vazia

EventType Parâmetro texto que especifica o tipo do Evento. Se

omitido, assume o valor "Tracking"

Objetos de Servidor 281

 NOME DESCRIÇÃO
UserFields Parâmetro do tipo Vetor, em que cada posição assume
o valor do campo especificado pelo usuário. Se omitido,
usa os valores definidos na Coleção de Campos de
Usuário de Alarmes do Servidor de Alarmes

AlarmSourceName Parâmetro texto que especifica o nome da Fonte de

Alarme. Se omitido, assume uma String vazia

FullAlarmSourceName Parâmetro texto que especifica o caminho completo da

Fonte de Alarme, incluindo a Área, a Configuração de
Alarme e as possíveis Pastas onde o Alarme está
inserido. Se omitido, assume uma String vazia

Os demais campos do Evento não podem ser especificados e sempre assumem os valores a seguir:
· Valor (CurrentValue): 0.0
· Qualidade (Quality): ""
· Condição Ativa (ConditionActive): 0 (Falso)
· Nome da Condição (ConditionName): ""
· Nome da Subcondição (SubConditionName): ""
· Reconhecido (Acked): 1 (Verdadeiro)
· Precisa Ack (AckRequired): 0 (Falso)
· Habilitado (Enabled): 1 (Verdadeiro)
· EventTimeUTC: *Sempre igual a EventTime (como em Eventos de Alarme)
· Máscara (ChangeMask): 0 (zero)
· Cookie: 0 (zero)

NOTA
Este método falha se a opção Armazenar alarmes em banco de dados está desmarcada, ou quando falha o
armazenamento no banco de dados.

O código a seguir contém um exemplo de uso deste método.

Sub CommandButton1_Click()
' No parâmetro UserFields, para cada elemento do array,
' é mostrado o valor atribuído a este elemento.
[Link]("ServidorAlarmes1").LogTrackingEvent_
"Clicou no botão", [Link], "Operação", 2, , _
"Botão1", , , array(1, 2, "a", "b")
End Sub

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Servidor de Alarmes (AlarmServer).

[Link].1 ActiveAlarms
Determina o número total de Alarmes ativos em uma aplicação. Esta propriedade é somente de leitura.

[Link].2 ActiveCritAlarms
Indica o número de Alarmes ativos com severidade Crítica em uma aplicação. Esta propriedade é somente de
leitura.

[Link].3 ActiveCritNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Crítica em uma aplicação. Esta propriedade é
somente de leitura.

282 Objetos de Servidor

[Link].4 ActiveHighAlarms
Indica o número de Alarmes ativos com severidade Alta em uma aplicação. Esta propriedade é somente de leitura.

[Link].5 ActiveHighNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Alta em uma aplicação. Esta propriedade é somente
de leitura.

[Link].6 ActiveLowAlarms
Indica o número de Alarmes ativos com severidade Baixa em uma aplicação. Esta propriedade é somente de leitura.

[Link].7 ActiveLowNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Baixa em uma aplicação. Esta propriedade é
somente de leitura.

[Link].8 ActiveMedAlarms
Indica o número de Alarmes ativos com severidade Média em uma aplicação. Esta propriedade é somente de
leitura.

[Link].9 ActiveMedNACKAlarms
Indica o número de Alarmes não reconhecidos com severidade Média em uma aplicação. Esta propriedade é
somente de leitura.

[Link].10 ActiveNACKAlarms
Indica o número total de Alarmes que estão sem reconhecimento em uma aplicação, ativos ou não. Esta propriedade
é somente de leitura.

[Link].11 BackupDiscardInterval
Indica o intervalo máximo de tempo, em minutos, horas, dias ou meses, dos dados de Alarmes 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).

NOTA
O tempo total indicado pela combinação desta propriedade com a propriedade BackupDiscardTimeUnit deve ser
maior que o tempo indicado pelas propriedades DiscardInterval e DiscardTimeUnit.

[Link].12 BackupDiscardTimeUnit
Esta propriedade indica a unidade de tempo em que os dados de Alarmes de backup permanecem armazenados
até serem descartados. Os valores possíveis para esta propriedade são 0: dtHour (horas), 1: dtDay (dias), 2: dtMonth
(meses, padrão) ou 3: dtMinute (minutos). Esta propriedade trabalha em conjunto com a propriedade
BackupDiscardInterval.

[Link].13 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.

[Link].14 DiscardInterval
Esta propriedade trabalha em conjunto com a propriedade DiscardTimeUnit e 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 é configurada com um valor menor ou igual ao valor da propriedade BackupDiscardInterval, o Elipse
E3 automaticamente ajusta o valor de BackupDiscardInterval como o dobro do valor desta propriedade.

Objetos de Servidor 283

[Link].15 DiscardTimeUnit
Esta propriedade trabalha em conjunto com a propriedade DiscardInterval e indica a unidade de tempo em que
os dados de Alarmes permanecem armazenados até que sejam descartados. Os valores possíveis para esta
propriedade são 0: dtHour (horas), 1: dtDay (dias), 2: dtMonth (meses, padrão) ou 3: dtMinute (minutos).

[Link].16 EnableBackupTable
Cria ou não uma tabela de backup onde os dados de Alarmes descartados permanecem por segurança. O valor
padrão desta propriedade é Verdadeiro, ou seja, a tabela é criada.

[Link].17 EnableDiscard
Indica se os dados dos Alarmes são descartados ou não após um certo tempo. O valor padrão desta propriedade
é Falso, ou seja, os dados são armazenados indefinidamente na tabela.

[Link].18 ExcludeSuppressedAlarmsOnCounters
Quando configurada para Verdadeiro, desconsidera os Alarmes suprimidos usando o tipo Arquivamento ou
usando o tipo Condição nos contadores gerais de Alarmes. O valor padrão desta propriedade é Falso.

[Link].19 InactiveCritNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Crítica em uma aplicação. Esta
propriedade é somente de leitura.

[Link].20 InactiveHighNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Alta em uma aplicação. Esta propriedade
é somente de leitura.

[Link].21 InactiveLowNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Baixa em uma aplicação. Esta propriedade
é somente de leitura.

[Link].22 InactiveMedNACKAlarms
Indica o número de Alarmes inativos e não reconhecidos com severidade Média em uma aplicação. Esta
propriedade é somente de leitura.

[Link].23 InactiveNACKAlarms
Determina o número total de Alarmes inativos e não reconhecidos em uma aplicação. Esta propriedade é somente
de leitura.

[Link].24 Logging
Cria ou não um registro com informações dos Alarmes no banco de dados especificado pela propriedade
DataSource. O valor padrão desta propriedade é Falso, ou seja, não cria este registro.

[Link].25 OutOfServiceAlarms
Determina o número total de Alarmes suprimidos usando o tipo Fora de Serviço (Out-of-Service) em uma aplicação.
Esta propriedade é somente de leitura.

[Link].26 ShelvedAlarms
Determina o número total de Alarmes ou Eventos suprimidos usando o tipo Arquivamento em uma aplicação. Esta
propriedade é somente de leitura.

[Link].27 SuppressedAlarms
Determina o número total de Alarmes suprimidos em uma aplicação, tanto usando o tipo Arquivamento quanto
usando o tipo Condição. Esta propriedade é somente de leitura.

284 Objetos de Servidor

[Link].28 SuppressedAlarmsLogging
Indica se os Alarmes são atualizados ou não no banco de dados enquanto estão suprimidos usando o tipo
Arquivamento ou usando o tipo Fora de Serviço (Out-of-Service). O valor padrão desta propriedade é Verdadeiro, ou
seja, os Alarmes são atualizados no banco de dados.

NOTA
Ao configurar esta propriedade com o valor Falso, a entrada e a saída de um Alarme da condição de supressão
ainda são registradas no banco de dados.

[Link].29 SuppressedByDesignAlarms
Determina o número total de Alarmes suprimidos usando o tipo Condição em uma aplicação. Esta propriedade é
somente de leitura.

[Link].30 TableName
Define um nome para a tabela de Alarmes. O valor padrão desta propriedade é "Alarms".

[Link].31 VerificationInterval
Esta propriedade trabalha em conjunto com a propriedade VerificationUnit para controlar o intervalo de tempo
que o Elipse E3 verifica a antiguidade dos dados de Alarmes, para depois descartá-los. O valor padrão desta
propriedade é 1 (uma unidade de tempo indicada na propriedade VerificationUnit).

[Link].32 VerificationUnit
Esta propriedade trabalha em conjunto com a propriedade VerificationInterval e indica a unidade de tempo em
que é realizada a verificação para descarte dos dados de Alarmes. Os valores possíveis para esta propriedade são 0:
dtHour (horas), 1: dtDay (dias), 2: dtMonth (meses, padrão) ou 3: dtMinute (minutos).

5.3 Banco de Dados

Esta seção contém informações sobre métodos e propriedades do objeto Banco de Dados (DBServer). Este objeto
não possui eventos associados.

5.3.1 Métodos
Esta seção contém informações sobre os métodos do objeto Banco de Dados (DBServer).

[Link] AccessSetDBPassword
AccessSetDBPassword(DBPwd)
Configura a senha de um banco de dados do tipo Access. O parâmetro DBPwd determina a senha a ser utilizada neste
banco de dados.

[Link] SetDBParameters
SetDBParameters(ServerName, UserName, Password, [DBName], [Port])
String de conexão com um 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 e pode ser omitido.
O parâmetro Port determina a porta TCP/IP para a conexão com um servidor MySQL ou PostgreSQL. O valor padrão
deste parâmetro é 0 (zero) e pode ser omitido para os demais tipos de bancos de dados.

NOTA
No caso do parâmetro Port, deixar o valor em 0 (zero, padrão) configura a porta TCP/IP da conexão para 3306 se o
servidor de banco de dados é MySQL e para 5432 se o servidor de banco de dados é PostgreSQL.

Objetos de Servidor 285

5.3.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Banco de Dados (DBServer).

[Link] ConnectionActive
Indica se o Elipse E3 possui uma conexão ativa com um banco de dados. O Elipse E3 normalmente utiliza duas
conexões com este banco de dados, uma para escrita e outra para leitura. Esta propriedade está em Verdadeiro se
pelo menos uma destas duas conexões está conectada e funcionando. Esta propriedade não deve ser utilizada para
detectar falhas de conexão, já que pode estar em Falso em diversas situações, como por exemplo:
· Quando o banco de dados não está em uso, ou seja, nenhuma operação de escrita ou leitura foi executada
· Quando o banco de dados foi recém reconfigurado, ou seja, 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, como por exemplo quando a rede não está disponível ou o
banco de dados foi fechado
· Quando o objeto Banco de Dados está desativado, apesar de que, mesmo com o objeto Banco de Dados
desativado, a conexão pode ser reconectada se a aplicação solicitar alguma leitura ou escrita imediata no banco
de dados

Esta propriedade é somente de leitura.

NOTA
Se a aplicação gera operações de banco de dados de forma consistente, isto é, se está sempre gerando novas
escritas ou leituras, esta propriedade reporta corretamente o estado da conexão com um banco de dados, já que
são eliminadas as demais situações em que esta propriedade poderia estar em Falso.

[Link] CustomConnectionString
Configura ou retorna uma String personalizada de conexão a um banco de dados. A configuração desta
propriedade só tem efeito quando a propriedade UseCustomConnectionString está configurada para Verdadeiro. O
valor padrão desta propriedade é uma String vazia.

[Link] EnableSynchronization
Indica, se habilitada, ou seja, em Verdadeiro, que o Elipse E3 também deve executar a gravação dos dados em uma
segunda base de dados simultaneamente, para permitir uma maior segurança. Se esta propriedade está habilitada e
há um servidor em modo Standby, o Elipse E3 executa a sincronização entre os bancos de dados dos dois
servidores. O valor padrão desta propriedade é Falso, ou seja, a sincronização está desabilitada.

[Link] MsSQLNetworkLibrary
Configura ou retorna o tipo de biblioteca de rede de um banco de dados do tipo SQL Server. Os valores possíveis
para esta propriedade estão descritos na propriedade NetLibrary.

[Link] MsSQLProvider
Configura ou retorna o provedor de dados OLE DB para acesso a um SQL Server. Os valores possíveis para esta
propriedade são 1: SQLOLEDB ou 2: MSOLEDBSQL (padrão).

NOTA
A opção de provedor de dados SQLOLEDB foi descontinuada pela Microsoft e não deve ser utilizada. Entretanto,
aplicações criadas em versões anteriores à versão 6.0 continuam funcionando normalmente. No caso de uma
atualização destas aplicações para a versão 6.0, o Elipse E3 adiciona automaticamente à String de conexão o
parâmetro de compatibilidade "DataTypeCompatibility=80".

[Link] NetLibrary
Configura o tipo de biblioteca de rede de um banco de dados. As opções disponíveis estão descritas na tabela a
seguir.

286 Objetos de Servidor

 Opções disponíveis para a propriedade NetLibrary
OPÇÃO DESCRIÇÃO
0 - Default Biblioteca do tipo padrão

1 - NamedPipes Biblioteca do tipo Named Pipes

2 - TcpIp Biblioteca do tipo Winsock TCP/IP

3 - SpxIpx Biblioteca do tipo SPX/IPX

4 - BanyanVines Biblioteca do tipo Banyan Vines

5 - MultiProtocol Biblioteca do tipo Multi-protocolo (RPC)

NOTA
Esta propriedade somente está disponível em bancos de dados do tipo SQL Server.

[Link] nRetries
Esta propriedade especifica o número de vezes que o Elipse E3 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 é igual a 0
(zero), apenas uma tentativa por operação é executada. Caso haja uma perda de conexão com o banco de dados
durante qualquer uma das tentativas, esta operação é abortada e as tentativas restantes são desconsideradas.

[Link] OracleEnableTimestamp
Habilita o uso do tipo de dados TIMESTAMP da Oracle, com precisão de milissegundos e disponível a partir da
versão 9.0. Se esta propriedade está configurada para Falso, o banco de dados usa o tipo de dados DATE, com
precisão de segundos.

NOTA
Configurar esta propriedade em Falso não tem efeito se a propriedade OracleUseADODrivers está configurada
para Verdadeiro.

[Link] OracleUseADODrivers
Permite usar as interfaces ADO (ActiveX Data Objects) do Oracle para que o objeto Consulta do Elipse E3 reconheça
o tipo de dados TIMESTAMP, possibilitando ler registros de tabelas do Oracle que possuam precisão de
milissegundos. Caso esta propriedade seja configurada em Falso, o banco de dados usa o tipo de dados DATE, com
precisão de segundos.

NOTA
Configurar esta propriedade em Verdadeiro não tem efeito se a propriedade OracleEnableTimestamp está
configurada para Falso.

[Link] ReconnectDelay
Esta propriedade determina o tempo de espera, em milissegundos, para que uma aplicação execute uma tentativa
de restabelecer uma conexão perdida com um banco de dados. O valor padrão desta propriedade é 2000, ou 2
(dois) segundos.

[Link] SourceDatabase
Caso o banco de dados seja do tipo Access, esta propriedade corresponde ao nome do arquivo no formato MDB.
Caso o banco de dados seja do tipo SQL Server, esta propriedade corresponde ao nome do SQL Server concatenado
com o banco de dados selecionado, no formato Servidor/BD. Caso o banco de dados seja do tipo Oracle, esta
propriedade corresponde ao nome da conexão criada. Caso o banco de dados seja do tipo MySQL, esta
propriedade corresponde ao nome do servidor concatenado com a porta TCP/IP mais o nome do banco de dados
usado na conexão, no formato Servidor:Porta/DB. Esta propriedade é somente de leitura.

Objetos de Servidor 287

[Link] SourceType
Indica o banco de dados utilizado por este objeto. Os valores possíveis para esta propriedade são 0 - stAccess:
Banco de dados do tipo Access (padrão), 1 - stOracle: Banco de dados do tipo Oracle, 2 - stSqlServer: Banco de
dados do tipo SQL Server, 3 - stPostgreSQL: Banco de dados do tipo PostgreSQL ou 4 - stMySQL: Banco de dados
do tipo MySQL.

[Link] TimeOutCommand
Contém o tempo de espera para qualquer operação de banco de dados, em segundos, antes que uma aplicação
gere um erro por time-out. O valor padrão desta propriedade é 180, ou seja, 3 (três) minutos.

[Link] TimeOutConnection
Contém o tempo de espera para realizar a conexão com um banco de dados, em segundos, antes que uma
aplicação gere um erro por time-out. O valor padrão desta propriedade é 15 segundos.

[Link] TotalFailedWrites
Indica quantas operações dos arquivos .e3o falharam e foram descartadas desde que a conexão com um banco de
dados foi ativada. Esta propriedade pode ser zerada automaticamente em diversas situações, como por exemplo:
· Ao desativar um objeto Banco de Dados
· Se o processo E3DBEngine é fechado por algum motivo
· Se os parâmetros de configuração da conexão de um objeto Banco de Dados são alterados

[Link] UseCustomConnectionString
Habilita ou desabilita o uso de uma String de conexão personalizada, configurada na propriedade
CustomConnectionString, ao conectar a um banco de dados.

[Link] UserName
Nome de login utilizado para se conectar a um banco de dados. Esta propriedade é somente de leitura.

[Link] UseTransaction
Define se um objeto Banco de Dados utiliza as transações do banco de dados ou não. Se esta propriedade está
configurada em Verdadeiro, cada bloco de operações de bancos de dados, 200 operações de Históricos, Storage,
Fórmulas e Alarmes, são executadas de uma vez só, ou seja, em uma única transação.

5.3.3 Conexão a um Servidor MySQL

Esta seção contém informações sobre propriedades do objeto Conexão a um Servidor MySQL (DBMySQLConnection).
Este objeto não possui eventos nem métodos associados.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Conexão a um Servidor MySQL
(DBMySQLConnection).

[Link].1 Database
Nome de um banco de dados em um servidor MySQL.

[Link].2 Login
Nome de login de um usuário de um banco de dados em um servidor MySQL.

[Link].3 Password
Senha do usuário de um banco de dados em um servidor MySQL.

[Link].4 Port
Número da porta TCP/IP usada ao conectar a um servidor MySQL.

288 Objetos de Servidor

[Link].5 Server
Endereço de um servidor MySQL.

5.3.4 Conexão a um Servidor PostgreSQL

Esta seção contém informações sobre propriedades do objeto Conexão a um Servidor PostgreSQL
(DBPostgresConnection). Este objeto não possui eventos nem métodos associados.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Conexão a um Servidor PostgreSQL
(DBPostgresConnection).

[Link].1 Database
Nome de um banco de dados em um servidor PostgreSQL.

[Link].2 Login
Nome de login de um usuário de um banco de dados em um servidor PostgreSQL.

[Link].3 Password
Senha do usuário de um banco de dados em um servidor PostgreSQL.

[Link].4 Port
Número da porta TCP/IP usada ao conectar a um servidor PostgreSQL.

[Link].5 Server
Endereço de um servidor PostgreSQL.

5.4 Coleção de Campos de Usuário de Alarmes

Esta seção contém informações sobre métodos e propriedades comuns à coleção de Campos de Usuário de Alarmes
de objetos de Servidor do Elipse E3 (AlarmUserFieldsCollection), retornada pela propriedade UserFields de Áreas de
Alarme e Fontes de Alarme.

5.4.1 Métodos Comuns

Esta seção contém informações sobre os métodos comuns à coleção de Campos de Usuário de Alarmes de objetos
de Servidor do Elipse E3 (AlarmUserFieldsCollection).

[Link] Item
Item(Index)
Retorna um objeto Campo de Usuário de Alarmes indicado pelo parâmetro Index, que pode ser o valor da
propriedade Index (inteiro) ou o valor da propriedade Name (texto) do objeto.

5.4.2 Propriedades Comuns

Esta seção contém informações sobre as propriedades comuns à coleção de Campos de Usuário de Alarmes de
objetos de Servidor do Elipse E3 (AlarmUserFieldsCollection).

[Link] 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). Esta propriedade é somente de leitura.

5.4.3 Campo de Usuário de Alarmes

Esta seção contém informações sobre as propriedades dos objetos do tipo Campo de Usuário de Alarmes
(AlarmUserField) contidos na Coleção de Campos de Usuário de Alarmes retornada pela propriedade UserFields de
Áreas de Alarme, Fontes de Alarme e de Objetos de Servidor com comportamento de Área de Alarme. Este objeto
não possui eventos nem métodos associados.

Objetos de Servidor 289

[Link] Propriedades
Esta seção contém informações sobre as propriedades dos objetos do tipo Campo de Usuário de Alarmes
(AlarmUserField) contidos na coleção de Campos de Usuário de Alarmes.

[Link].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. Esta propriedade é somente de leitura.

[Link].2 Link
Retorna ou modifica a Associação configurada para este Campo de Usuário de Alarmes. Para alterar em tempo de
execução a Associação configurada nesta propriedade, deve-se desativar o objeto. O script a seguir contém um
exemplo de uso desta propriedade.
Dim sAlarm
Set sAlarm = _
[Link]("[Link].DigitalAlarm1")
[Link]()
[Link]("BatchName").Link = _
"[Link]"
[Link]()

[Link].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. Esta propriedade é somente de leitura.

[Link].4 Value
Retorna ou configura o valor atual do Campo de Usuário de Alarmes. Esta propriedade tem um comportamento
diferenciado dependendo se o objeto está ativo ou inativo. Com o objeto ativo, o valor retornado na leitura desta
propriedade obedece à seguinte lista de prioridades:
1. Se há um valor forçado (propriedade ValueSource igual a evsForcedValue), retorna este valor
2. Se há uma Associação configurada (propriedade ValueSource igual a evsLink), retorna o valor atual da
Associação
3. Busca o valor deste Campo de Usuário na Área hierarquicamente superior (percorre a hierarquia de Áreas em
sentido ascendente)
4. Se não há nenhuma Área hierarquicamente superior que tenha um valor forçado ou uma Associação configurada
para este Campo de Usuário, recupera o valor padrão do Campo de Usuário configurado no Servidor de Alarmes

Se o objeto está inativo, a leitura desta propriedade retorna o valor forçado, caso exista (propriedade ValueSource
igual a evsForcedValue). Se não há um valor forçado, a leitura da propriedade falha.
O comportamento das escritas nesta propriedade é o mesmo, tanto com o objeto ativo como inativo. A escrita falha
caso haja uma Associação configurada (propriedade ValueSource igual a evsLink). Caso contrário, o novo valor é
aceito e a propriedade ValueSource é automaticamente configurada para evsForcedValue.

[Link].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 (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 os casos, não é possível escrever o
valor evsLink. Para trocar esta propriedade para o valor evsLink, deve-se escrever diretamente na propriedade Link,
desativando o objeto se estiver em tempo de execução.

290 Objetos de Servidor

NOTA
Ao exportar um objeto Campo de Usuário de Alarmes, esta propriedade deve ser colocada após as propriedades
Link e Value na ordem das colunas.

5.5 Drivers
Esta seção contém informações sobre eventos, métodos e propriedades dos objetos Driver de Comunicação, Tag de
Comunicação, Bloco de Comunicação, Elemento de Bloco de Comunicação, Driver de Comunicação OPC, Tag de
Comunicação OPC, Bloco de Comunicação OPC, Elemento de Bloco de Comunicação OPC, Driver de Comunicação
OPC UA., Assinatura OPC UA, Tag de Comunicação OPC UA, Bloco de Comunicação OPC UA e Elemento de Bloco
de Comunicação OPC UA.

5.5.1 Driver de Comunicação

Esta seção contém informações sobre eventos, métodos e propriedades do objeto Driver de Comunicação (IODriver).

[Link] Eventos
Esta seção contém informações sobre os eventos do objeto Driver de Comunicação (IODriver).

[Link].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. O script a seguir contém um exemplo de
uso deste evento.
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

[Link].2 AfterStop
AfterStop()
Ocorre depois que o Driver de Comunicação finalizou a comunicação. Utilize este evento para executar alguma ação
necessária após terminada a comunicação.

[Link].3 BeforeStart
BeforeStart()
Ocorre quando o Driver de Comunicação está prestes a iniciar a comunicação. Utilize este evento para executar
alguma ação necessária antes de iniciar a comunicação, como por exemplo a configuração de parâmetros. O script a
seguir contém um exemplo de uso deste evento.
Sub Driver1_BeforeStart()
' Executa a inicialização dos parâmetros do Driver
' antes de iniciar a comunicação
P1 = 0
P2 = 20
P3 = 80
P4 = 0
End Sub

[Link].4 BeforeStop
BeforeStop()
Ocorre quando o Driver de Comunicação está prestes a finalizar a comunicação. Utilize este evento para executar
alguma ação necessária antes que a comunicação seja terminada, como por exemplo escrever ou ler valores de um
equipamento antes que a comunicação não esteja mais disponível.

Objetos de Servidor 291

[Link].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 este evento para
saber quando ocorreu uma falha de escrita ou leitura. As variáveis de evento recebem informações sobre o erro
ocorrido. Com estes valores, é possível rastrear quais Tags de Comunicação estão apresentando problemas de
comunicação.
Variáveis do evento OnCommError
NOME DESCRIÇÃO
EvtType Informa qual o tipo de operação o Driver de Comunicação
estava efetuando quando ocorreu o erro, conforme as
opções a seguir:
· 0: Erro de leitura de um só Elemento de Bloco de
Comunicação (Size = 1). Param1 é N1, Param2 é N2,
Param3 é N3 e Param4 é N4
· 1: Erro de escrita de um só Elemento de Bloco de
Comunicação (Size = 1). Param1 é N1, Param2 é N2,
Param3 é N3 e Param4 é N4
· 2: Erro de leitura de um Bloco de Comunicação. Size é
determinado pelo número de Elementos de Bloco de
Comunicação. Param1 é N1, Param2 é N2, Param3 é
N3 e Param4 é N4
· 3: Erro de escrita de um Bloco de Comunicação. Size é
determinado pelo número de Elementos de Bloco de
Comunicação. Param1 é N1, Param2 é N2, Param3 é
N3 e Param4 é N4

Size Quantidade de valores escritos ou lidos

Element Índice do Elemento de Bloco de Comunicação que estava

sendo lido ou escrito, dentro do Bloco de Comunicação

N1 Parâmetro 1 (um) da operação de leitura ou escrita que

gerou o erro

N2 Parâmetro 2 (dois) da operação de leitura ou escrita que

gerou o erro

N3 Parâmetro 3 (três) da operação de leitura ou escrita que

gerou o erro

N4 Parâmetro 4 (quatro) da operação de leitura ou escrita

que gerou o erro

O script a seguir contém um exemplo de uso deste evento.

Sub Driver1_OnCommError(Type, Size, Element, N1, N2, N3, N4)
[Link]("Dados.TagInterno1").Value = _
[Link]("Dados.TagInterno1").Value + 1
[Link]("[Link]").Value = EvtType
[Link]("[Link]").Value = Size
[Link]("[Link]").Value = Element
[Link]("Dados.N1").Value = N1
[Link]("Dados.N2").Value = N2
[Link]("Dados.N3").Value = N3
[Link]("Dados.N4").Value = N4
End Sub

[Link].6 OnCommErrorEx
OnCommErrorEx(ErrorInfo)
Ocorre logo após a execução do método OnCommError.

292 Objetos de Servidor

 Informações do parâmetro ErrorInfo
NOME DESCRIÇÃO
[Link] Indica o tipo de operação que causou o erro. Os valores
possíveis são 0: Leitura de Tag de Comunicação, 1:
Escrita em Tag de Comunicação, 2: Leitura de Bloco de
Comunicação ou 3: Escrita em Bloco de Comunicação

[Link] Tamanho do Bloco de Comunicação que ocasionou o

erro. Se é um Tag de Comunicação, Size é igual a 1 (um)

[Link] Índice do Elemento de Bloco de Comunicação que

causou o erro

[Link] Parâmetros Nx ou Bx, em que x pode ser 1 (um), 2 (dois),

3 (três) ou 4 (quatro), da operação que causou o erro

[Link] Parâmetro ParamDevice (String) da operação que

causou o erro

[Link] Parâmetro ParamItem (String) da operação que causou

o erro

[Link].7 OnTagRead
OnTagRead(Tag)
Ocorre na leitura de um Tag de Comunicação, sempre que um novo valor ou um erro é retornado pelo Driver de
Comunicação, ou seja, se o valor ou a qualidade do Tag de Comunicação não mudarem, este evento não é disparado.
Para que este 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. O script a seguir contém um exemplo de uso deste evento.
Sub Tags_OnTagRead(Tag)
Set Obj = [Link]("[Link]")
[Link] = [Link]
Set Obj = [Link]("[Link]")
[Link] = True
Set Obj = [Link]("[Link]")
[Link] = TypeName(Tag)
End Sub

[Link].8 OnTagWrite
OnTagWrite(Tag, Succeeded, User)
Ocorre quando uma escrita é disparada em qualquer Tag de Comunicação do Driver de Comunicação.
Variáveis do evento OnTagWrite
NOME DESCRIÇÃO
Tag Uma referência para o objeto do Tag de Comunicação
que está sofrendo a escrita. Por exemplo, pode-se
acessar a propriedade do Tag de Comunicação com a
sintaxe [Link]

Succeeded Indica o sucesso ou falha da escrita

User Parâmetro que recebe o usuário que realizou a escrita. O

valor padrão deste parâmetro é "System". Se não houver
nenhum usuário logado no Elipse E3 Viewer que gerou
o evento, este parâmetro contém o valor "Anonymous"

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Driver de Comunicação (IODriver).

Objetos de Servidor 293

[Link].1 Write
Write(N1, N2, N3, N4, Value, [WriteSyncMode])
Executa a escrita de um dado em um 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 de Comunicação. O parâmetro Value
define o valor a ser escrito no Driver de Comunicação. O parâmetro WriteSyncMode permite utilizar um modo de
escrita diferente do utilizado pelo Driver de Comunicação. As opções disponíveis para este parâmetro são 0: Usa o
modo de escrita configurado no Driver de Comunicação, 1: Executa uma escrita síncrona ou 2: Executa uma escrita
assíncrona, sem confirmação.
Se o parâmetro WriteSyncMode é omitido, também é utilizado o modo de escrita configurado no Driver de
Comunicação. Para mais detalhes sobre estes parâmetros, consulte a documentação do Driver.

[Link].2 WriteEx
WriteEx(N1, N2, N3, N4, Value, [Timestamp], [Quality], [WriteStatus], [WriteSyncMode])
Executa a escrita de um dado em um 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 de Comunicação. O parâmetro Value
define o valor a ser escrito no Driver de Comunicação. Para mais 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. O parâmetro Timestamp especifica a data e hora a ser
escrita no Tag de Comunicação, se suportada pelo equipamento. Se omitido, assume a data e hora do momento da
operação de escrita. O parâmetro Quality indica a qualidade, de 0 (zero) a 255. Se omitido, assume a qualidade Boa
(192). O parâmetro WriteStatus recebe um valor retornado pelo Driver de Comunicação, que indica o status da escrita,
se suportado, de acordo com a documentação própria. O parâmetro WriteSyncMode permite utilizar o modo de
escrita diferente do utilizado no Driver de Comunicação. As opções disponíveis para este parâmetro são 0: Usa o
modo de escrita configurado no Driver de Comunicação, 1: Executa uma escrita síncrona ou 2: Executa uma escrita
assíncrona, sem confirmação.
Se o parâmetro WriteSyncMode é omitido, também é utilizado o modo de escrita configurado no Driver de
Comunicação. O script a seguir contém um exemplo de uso deste método.
Dim status
If [Link](0, 0, 0, 0, 100, , , status) Then
MsgBox "Escrita bem-sucedida, status = " & status
Else
MsgBox "Escrita falhou, status = " & status
End If

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Driver de Comunicação (IODriver).

[Link].1 AsyncBatchFlushTimeMs
Esta propriedade define o tempo máximo que uma operação assíncrona pode esperar no E3Run antes de ser
enviada para o Servidor de I/O. Os valores possíveis para esta propriedade variam entre 10 e 10000 (10 segundos).
Valores menores que 10 utilizam o valor de 10 milissegundos. O valor padrão desta propriedade é -1 (menos um), ou
seja, o tempo de espera é definido na opção Tempo Máximo de Espera (milissegundos) do grupo Agrupamento de
Operações Assíncronas da aba Propriedades da configuração de um Domínio.

[Link].2 AsyncBatchSize
Esta propriedade define o número máximo de operações por Driver de Comunicação armazenadas na memória do
E3Run antes de enviar para o Servidor de I/O. Os valores possíveis para esta propriedade variam entre 2 (dois) e
100000. O valor 0 (zero) desabilita o agrupamento de operações para este Driver de Comunicação. O valor padrão
desta propriedade é -1 (menos um), ou seja, o agrupamento é definido na opção Número Máximo de Operações por
Grupo do grupo Agrupamento de Operações Assíncronas da aba Propriedades da configuração de um Domínio.

[Link].3 DisableIOServerPool
Força este Driver de Comunicação a não participar do Pool de processos do Servidor de I/O, ou seja, este Driver de
Comunicação executa em um Servidor de I/O exclusivo. O valor padrão desta propriedade é Falso.

294 Objetos de Servidor

NOTA
Para mais informações, consulte o tópico Pool de Processos do Servidor de I/O no Manual do Usuário do Elipse E3.

[Link].4 DriverLocation
Define qual é o Driver utilizado por este Driver de Comunicação para efetuar a comunicação com um equipamento.
Esta propriedade aceita uma String com o caminho completo do Driver, caso não esteja no mesmo diretório do
Domínio, ou o caminho relativo se estiver no mesmo diretório do Domínio. Caso não haja um Domínio aberto no
Elipse E3 Studio, o caminho relativo é considerado a partir da pasta onde se encontra o projeto ou biblioteca
contendo este 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.

NOTA
Aconselha-se utilizar sempre a opção Procurar DLL, no menu contextual do Driver de Comunicação para configurar
corretamente esta propriedade.

[Link].5 DriverName
Esta propriedade contém uma String que descreve o Driver associado a este Driver de Comunicação. Para isto,
deve-se antes configurar a propriedade DriverLocation. Esta propriedade é somente de leitura.

[Link].6 EnableReadGrouping
Permite otimizações de leitura ou agrupamento automático de Tags de Comunicação. Esta propriedade não pode
ser alterada com este objeto ativo. O valor padrão desta propriedade é Verdadeiro. A otimização de leitura só
acontece se este Driver de Comunicação suportar este recurso.

[Link].7 P1
Utilize esta propriedade para configurar um Driver de Comunicação. Consulte a documentação do Driver para a
correta configuração. Esta propriedade não pode ser modificada após iniciada a comunicação. O valor padrão desta
propriedade é 0 (zero). O script a seguir contém um exemplo de uso desta propriedade.
Sub Driver1_BeforeStart()
' Driver1 é um objeto do tipo Driver de Comunicação
DriverLocation = "c:\driver\[Link]"
P1 = 2
P2 = 1
P3 = 9600
End Sub

[Link].8 P2
Utilize esta propriedade para configurar um Driver de Comunicação. Consulte a documentação do Driver para a
correta configuração. Esta propriedade não pode ser modificada após iniciada a comunicação. O valor padrão desta
propriedade é 0 (zero). O script a seguir contém um exemplo de uso desta propriedade.
Sub Driver1_BeforeStart()
' Driver1 é um objeto do tipo Driver de Comunicação
DriverLocation = "c:\driver\[Link]"
P1 = 2
P2 = 1
P3 = 9600
End Sub

[Link].9 P3
Utilize esta propriedade para configurar um Driver de Comunicação. Consulte a documentação do Driver para a
correta configuração. Esta propriedade não pode ser modificada após iniciada a comunicação. O valor padrão desta
propriedade é 0 (zero). O script a seguir contém um exemplo de uso desta propriedade.
Sub Driver1_BeforeStart()
' Driver1 é um objeto do tipo Driver de Comunicação
DriverLocation = "c:\driver\[Link]"
P1 = 2
P2 = 1
P3 = 9600
End Sub

Objetos de Servidor 295

[Link].10 P4
Utilize esta propriedade para configurar um Driver de Comunicação. Consulte a documentação do Driver para a
correta configuração. Esta propriedade não pode ser modificada após iniciada a comunicação. O valor padrão desta
propriedade é 0 (zero). O script a seguir contém um exemplo de uso desta propriedade.
Sub Driver1_BeforeStart()
' Driver1 é um objeto do tipo Driver de Comunicação
DriverLocation = "c:\driver\[Link]"
P1 = 2
P2 = 1
P3 = 9600
P4 = 500
End Sub

[Link].11 ParamDevice
Define o endereço do equipamento acessado por este Driver de Comunicação. Esta propriedade é herdada pelos
Tags de Comunicação filhos deste objeto, que podem sobrescrever este valor, se necessário.

[Link].12 ReadRetries
Indica o número de re-tentativas de leitura deste Driver de Comunicação em caso de erro. Se esta propriedade é
configurada para 2 (dois), por exemplo, indica que este Driver de Comunicação tenta duas vezes mais uma
comunicação falhada, sem contar a tentativa original.

[Link].13 ShareMaximum
Esta propriedade define o número máximo de Drivers de Comunicação que são agrupados em um Servidor de I/O
compartilhado. Esta propriedade só é utilizada se a propriedade ShareServer está habilitada. O script a seguir contém
um exemplo de uso desta propriedade.
' Este Driver não é compartilhado
ShareServer = False
ShareMaximum = <qualquer valor>
' Todos os drivers são agrupados no mesmo I/O Server
' Não define um limite
ShareServer = True
ShareMaximum = 0
' Agrupa cada 5 Drivers em um I/O Server
ShareServer = True
ShareMaximum = 5

[Link].14 ShareServer
Se esta propriedade está configurada para Verdadeiro, isto significa que este Driver de Comunicação compartilha a
execução entre os demais Drivers de Comunicação que possuam a mesma String em DriverLocation. Isto implica que
somente o primeiro Driver de Comunicação configurado executa a inicialização da comunicação. Todos os demais
Drivers de Comunicação compartilhados ignoram todos os parâmetros de configuração, de P1 a P4, e também outras
configurações. Do contrário, se a propriedade está configurada para Falso, este Driver de Comunicação não
compartilha qualquer tipo de comunicação com outros Drivers de Comunicação. Esta propriedade não pode ser
modificada após iniciada a comunicação. O valor padrão desta propriedade é Falso.

[Link].15 WriteFeedbackMode
Esta propriedade permite controlar a confirmação, ou feedback, das escritas em Tags de Comunicação. É aplicável
somente a Tags de Comunicação 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 de Comunicação 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 leitura do Tag de Comunicação é realizada
normalmente na próxima varredura

1 - wfImmediateReadAfterWrite Após cada escrita, uma leitura de confirmação é

realizada o mais cedo possível (valor padrão)

296 Objetos de Servidor

 OPÇÃO DESCRIÇÃO
2 - wfTrustWriteSuccess Se este Driver de Comunicação indicar sucesso na escrita,
o valor escrito é assumido diretamente pelo Tag de
Comunicação, sem lê-lo do equipamento

Aplicações anteriores à existência desta propriedade assumem o valor 0 - wfWaitNextRead quando carregadas. O
script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Dim modo
modo = [Link]("Driver1").WriteFeedbackMode
MsgBox modo
Select case modo
Case 0
MsgBox "A leitura do Tag é realizada na próxima varredura."
Case 1
MsgBox "Após cada escrita, uma leitura de confirmação _
é realizada o mais cedo possível."
Case 2
MsgBox "Se este Driver indicar sucesso na escrita, _
o valor escrito é assumido diretamente pelo Tag, _
sem lê-lo do equipamento."
End Select
End Sub

NOTA
Quando é usado o modo 2 - wfTrustWriteSuccess, a estampa de tempo e a qualidade podem estar erradas, já que
em uma escrita bem sucedida, o valor é assumido pelo Tag de Comunicação sem buscar a estampa de tempo e a
qualidade no equipamento. Além disto, o próprio valor assumido pode ter um pequeno desvio devido a qualquer
tipo de arredondamento que possa ocorrer no Driver de Comunicação ou no equipamento. Deve ser levado em
conta ainda que alguns Drivers de Comunicação ou protocolos podem indicar sucesso mesmo quando a escrita
falha. Por tudo isto, os outros modos, 1 - wfImmediateReadAfterWrite ou 0 - wfWaitNextRead, devem ser
preferidos sempre que possível.

[Link].16 WriteNullAsEmpty
Esta propriedade permite que um Driver de Comunicação converta um valor recebido como Null para Empty em
casos onde o Driver de Comunicação não aceita valores nulos. Tanto a qualidade quanto a estampa de tempo do
valor são propagados sem alteração, exceto no caso em que o valor recebido como Null tenha uma qualidade boa.
Nesta situações, o valor é convertido para Empty e a qualidade é alterada para 0 (zero, qualidade ruim). O valor
padrão desta propriedade é Falso.

[Link].17 WriteRetries
Indica o número de re-tentativas de escrita deste Driver de Comunicação em caso de erro. Se esta propriedade é
igual a 2 (dois), indica que este Driver de Comunicação tenta duas vezes mais uma comunicação falhada, sem contar a
tentativa original.

[Link].18 WriteSyncMode
Determina como as escritas são enviadas para o Servidor de I/O, no 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. Este é o valor padrão

1 - wsmSync Modo síncrono. Sempre que um valor é escrito em

algum Tag de Comunicação, o E3Run envia a escrita para
o Servidor de I/O e aguarda o retorno da escrita

Objetos de Servidor 297

 OPÇÃO DESCRIÇÃO
2 - wsmAsyncUnconfirmed Modo assíncrono sem confirmação. Todas as escritas
são enviadas para o Servidor de I/O sem aguardar o
retorno, e assume-se sempre que a escrita funcionou.
Quando em modo assíncrono, os métodos de escrita
dos Tags de Comunicação, Write e WriteEx, sempre
retornam Verdadeiro imediatamente, e o status da
escrita, nos métodos que retornam este status, é sempre
vazio ou Empty. O evento OnTagWrite deste Driver de
Comunicação é executado assim que a escrita é enviada
para o Servidor de I/O, e o parâmetro Succeeded
permanece sempre em Verdadeiro

As escritas assíncronas são executadas pelo Servidor de I/O assim que este Driver de Comunicação estiver disponível,
quando a leitura atual terminar. Se várias escritas assíncronas são enviadas para o Servidor de I/O, este Driver de
Comunicação só retoma as leituras depois que todas as escritas assíncronas são executadas.

[Link] Bloco de Comunicação

Esta seção contém informações sobre eventos, métodos e propriedades do objeto Bloco de Comunicação (IOBlock).

[Link].1 Eventos
Esta seção contém informações sobre os eventos do objeto Bloco de Comunicação (IOBlock).

[Link].1.1 OnRead
OnRead()
Ocorre quando uma leitura do Bloco de Comunicação é efetuada pelo Driver de Comunicação. Utilize este evento para
efetuar alguma operação logo após algum dado ser modificado no objeto Bloco de Comunicação, como por exemplo
as propriedades Quality, TimeStamp ou ainda a propriedade Value de algum Elemento de Bloco de Comunicação. O
script a seguir contém um exemplo de uso deste evento.
Sub IOBloco1_OnRead()
' Ao ler o bloco, atribui ao tag InternalTag1
' o valor do elemento de bloco elm1
Set obj = [Link]("DataServer1.InternalTag1")
Set elm = [Link]("Driver1.IOBloco1.elm1")
[Link] = [Link]
End Sub

[Link].2 Métodos
Esta seção contém informações sobre os métodos do objeto Bloco de Comunicação (IOBlock).

[Link].2.1 Write
Write([WriteSyncMode])
Executa a escrita do valor corrente do Bloco de Comunicação em um equipamento. Normalmente, este comando de
script só é usado quando a propriedade AllowWrite deste objeto é igual a Falso. O parâmetro WriteSyncMode
permite utilizar o modo de escrita diferente do utilizado no Driver de Comunicação. As opções disponíveis para este
parâmetro são 0: Usa o modo de escrita configurado no Driver de Comunicação, 1: Executa uma escrita síncrona ou 2:
Executa uma escrita assíncrona, sem confirmação.
Se o parâmetro WriteSyncMode é omitido, também é utilizado o modo de escrita configurado no Driver de
Comunicação. Para mais detalhes, consulte a documentação do Driver. Este método retorna um Booleano que indica o
sucesso ou não da operação.

[Link].2.2 WriteEx
WriteEx([Value], [Timestamp], [Quality], [WriteStatus], [WriteSyncMode])
Executa a escrita de um valor em um equipamento. Todos os parâmetros são opcionais e, se omitidos, o
comportamento do método é igual ao do método Write. Este método retorna um Booleano que indica o sucesso ou
não da operação. O parâmetro Value define o valor a ser escrito no Driver de Comunicação. O tipo de dados
depende do Driver de Comunicação e, se omitido, assume o valor corrente do Bloco de Comunicação. O parâmetro

298 Objetos de Servidor

Timestamp especifica a data e hora a ser escrita no Bloco de Comunicação, se suportada pelo equipamento. Se
omitido, assume a data e hora do momento da operação de escrita. O parâmetro Quality indica a qualidade, de 0
(zero) a 255. Se omitido, assume a qualidade Boa (192). O parâmetro WriteStatus recebe um valor retornado pelo
Driver de Comunicação, que indica o status da escrita, se suportado, de acordo com a documentação própria. O
parâmetro WriteSyncMode permite utilizar o modo de escrita diferente do utilizado no Driver de Comunicação. As
opções disponíveis para este parâmetro são 0: Usa o modo de escrita configurado no Driver de Comunicação, 1:
Executa uma escrita síncrona ou 2: Executa uma escrita assíncrona, sem confirmação.
Se o parâmetro WriteSyncMode é omitido, também é utilizado o modo de escrita configurado no Driver de
Comunicação. O script a seguir contém um exemplo de uso deste método.
Sub Tag1_OnRead()
' O método WriteEx pode ser usado para transferir
' valores de variáveis de um driver para outro.
[Link]("[Link]")._
WriteEx Value, TimeStamp, Quality
End Sub

[Link].3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Bloco de Comunicação (IOBlock).

[Link].3.1 AdviseType
Controla o modo Advise. As opções disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade AdviseType
OPÇÃO DESCRIÇÃO
0 - AlwaysInAdvise O Bloco de Comunicação é mantido atualizado se a
propriedade AllowRead é igual a Verdadeiro

1 - AdviseWhenLinked O Bloco de Comunicação só é atualizado se AllowRead é

igual a Verdadeiro e o Bloco de Comunicação está
associado a algum objeto ativo, como por exemplo um
Display de uma Tela aberta ou um Alarme habilitado,
entre outros. A associação do Bloco de Comunicação
para este propósito pode ser executada nas
propriedades Value, RawValue, Quality e de Bit00 até
Bit31 de Elementos de Bloco de Comunicação, e Quality
e TimeStamp de Blocos de Comunicação (valor padrão)

[Link].3.2 AllowRead
Define se este Bloco de Comunicação deve ou não ser lido pelo Driver de Comunicação. Caso esta propriedade
esteja habilitada, então o Driver automaticamente atualiza os Elementos de Bloco de Comunicação inseridos neste
Bloco de Comunicação, em intervalos de tempo definidos pela propriedade Scan. Caso contrário, este Bloco de
Comunicação não é lido ou atualizado. O valor padrão desta propriedade é Verdadeiro. O script a seguir contém um
exemplo de uso desta propriedade.
Sub Botao1_Click()
' Faz com que seja parada a leitura do bloco
Set obj = [Link]("Driver1.bloco1")
[Link] = False
End Sub

[Link].3.3 AllowWrite
Define se este Bloco de Comunicação deve ou não ser escrito quando a propriedade Value dos Elementos de Bloco
de Comunicação é modificada. Se esta propriedade está configurada para Verdadeiro, as modificações são enviadas
para o equipamento associado ao Driver de Comunicação. Caso contrário as modificações são ignoradas. Os
Elementos de Bloco 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. O script a seguir contém um exemplo de
uso desta propriedade.
Sub Botao1_Click()
' Faz com que seja desabilitada a escrita do bloco
Set obj = [Link]("Driver1.bloco1")
[Link] = False
End Sub

Objetos de Servidor 299

[Link].3.4 B1
Especifica a qual conjunto de dados no equipamento este Bloco de Comunicação está associado. Consulte a
documentação do Driver para a correta configuração. Esta propriedade pode ser modificada após iniciada a
comunicação. O script a seguir contém um exemplo de uso desta propriedade.
Sub Bloco1_BeforeStart()
B1 = 2
B2 = 1
B3 = 9600
End Sub

[Link].3.5 B2
Especifica a qual conjunto de dados no equipamento este Bloco de Comunicação está associado. Consulte a
documentação do Driver para a correta configuração. Esta propriedade pode ser modificada após iniciada a
comunicação. O script a seguir contém um exemplo de uso desta propriedade.
Sub Bloco1_BeforeStart()
B1 = 2
B2 = 1
B3 = 9600
End Sub

[Link].3.6 B3
Especifica a qual conjunto de dados no equipamento este Bloco de Comunicação está associado. Consulte a
documentação do Driver para a correta configuração. Esta propriedade pode ser modificada após iniciada a
comunicação. O script a seguir contém um exemplo de uso desta propriedade.
Sub Bloco1_BeforeStart()
B1 = 2
B2 = 1
B3 = 9600
End Sub

[Link].3.7 B4
Especifica a qual conjunto de dados no equipamento este Bloco de Comunicação está associado. Consulte a
documentação do Driver para a correta configuração. Esta propriedade pode ser modificada após iniciada a
comunicação. O script a seguir contém um exemplo de uso desta propriedade.
Sub Bloco1_BeforeStart()
B1 = 2
B2 = 1
B3 = 9600
B4 = 524
End Sub

[Link].3.8 EnableDeadBand
Esta propriedade habilita ou desabilita a propriedade PercentDeadBand dos Elementos de Bloco de Comunicação.
Se esta propriedade está configurada para Verdadeiro, o valor do Bloco de Comunicação é atualizado somente se
este mudar e o novo valor exceder o limite definido pela propriedade PercentDeadBand de qualquer um dos
Elementos de Bloco de Comunicação. Caso contrário, o Bloco de Comunicação é sempre atualizado e o limite de
banda morta não é verificado. Sempre que possível, é recomendado manter a banda morta habilitada, pois melhora a
performance da aquisição e do processamento de dados. Normalmente, a banda morta é desabilitada apenas para
os Blocos de Comunicação que retornem valores representando eventos que precisam ser tratados no evento
OnRead do Bloco de Comunicação. O valor padrão desta propriedade é Verdadeiro.

NOTAS
· Caso haja mais de um Elemento de Bloco de Comunicação mapeado para o mesmo índice, a configuração de
banda morta utilizada é aquela que resulte no menor valor absoluto de banda morta.
· Se algum índice do Bloco de Comunicação possuir um Elemento de Bloco de Comunicação não mapeado, a banda
morta neste índice é igual a 0 (zero), ou seja, qualquer variação no valor do Elemento de Bloco de Comunicação
viola a banda morta.
· Se esta propriedade está habilitada, o último valor enviado ao Bloco de Comunicação é comparado com o valor
lido no momento, Elemento por Elemento. Se qualquer um dos Elementos de Bloco de Comunicação violar a
banda morta, o Bloco de Comunicação inteiro é atualizado.

300 Objetos de Servidor

[Link].3.9 EnableDriverEvent
Esta propriedade é utilizada para controlar a geração do evento OnTagRead, que ocorre no Driver de
Comunicação que contém o Bloco de Comunicação. Se esta propriedade do Bloco de Comunicação está configurada
para Verdadeiro, é habilitada a geração do evento OnTagRead por este Bloco de Comunicação. Caso contrário, não
ocorre. O Tag de Comunicação, Bloco de Comunicação e Elemento de Bloco de Comunicação podem gerar este
evento. O evento ocorre no Driver de Comunicação e não no Bloco de Comunicação.

[Link].3.10 ParamDevice
Define o endereço do equipamento acessado pelo Bloco de Comunicação. Esta propriedade é herdada do Driver
de Comunicação, mas o valor pode ser sobrescrito, se necessário.

[Link].3.11 ParamItem
Identifica o dado que este Bloco de Comunicação acessa em um equipamento.

[Link].3.12 Quality
Esta propriedade informa qual a qualidade do valor contido na propriedade Value. Cada vez que o Driver de
Comunicação atribui um novo valor para o Bloco de Comunicação, também é configurada a qualidade daquele dado.
Esta propriedade é somente de leitura. O valor padrão desta propriedade é 0 (zero, Qualidade Ruim).

NOTA
Para mais informações sobre qualidade, consulte o tópico Qualidade no Manual do Usuário do Elipse E3.

[Link].3.13 Scan
Especifica qual tempo de varredura é utilizado pelo servidor para atualizar o Bloco de Comunicação. Esta
propriedade é representada em milissegundos, pode ser modificada após iniciada a comunicação e é utilizada apenas
quando a propriedade AllowRead está habilitada. Ao configurar esta propriedade nos diversos Blocos de
Comunicação presentes na aplicação, recomenda-se aumentar o valor desta propriedade para aqueles Blocos de
Comunicação que não variam muito no equipamento, possibilitando assim que outros Blocos de Comunicação de
maior prioridade sejam lidos com maior frequência, aumentando assim a performance geral do sistema. O valor
padrão desta propriedade é 1000, ou um segundo. O valor do scan deve ser maior que 0 (zero). O script a seguir
contém um exemplo de uso desta propriedade.
Sub Bloco de comunicacao1_BeforeStart()
Scan = 152
End Sub

[Link].3.14 Size
Define o tamanho do conjunto de valores deste Bloco de Comunicação. 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 de
Bloco de Comunicação, possibilita-se o acesso aos valores lidos e também permite a escrita de valores para o
equipamento. O valor padrão desta propriedade é 0 (zero). O script a seguir contém um exemplo de uso desta
propriedade.
Sub Bloco de comunicacao1_BeforeStart()
Size = 10
End Sub

[Link].3.15 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. Esta propriedade é somente de leitura. O valor padrão desta propriedade é "00:00:00".

[Link].4 Elemento de Bloco de Comunicação

Esta seção contém informações sobre métodos e propriedades do objeto Elemento de Bloco de Comunicação
(IOBlockElement). Este objeto não possui eventos associados.

Objetos de Servidor 301

[Link].4.1 Métodos
Esta seção contém informações sobre os métodos do objeto Elemento de Bloco de Comunicação (IOBlockElement).
Write
Write([WriteSyncMode])
Executa a escrita do valor corrente do Elemento de Bloco de Comunicação no equipamento. Normalmente, este
comando de script só é usado quando a propriedade AllowWrite deste objeto é igual a Falso. O parâmetro
WriteSyncMode permite utilizar o modo de escrita diferente do utilizado no Driver de Comunicação. As opções
disponíveis para este parâmetro são 0: Usa o modo de escrita configurado no Driver de Comunicação, 1: Executa uma
escrita síncrona ou 2: Executa uma escrita assíncrona, sem confirmação.
Se o parâmetro WriteSyncMode é omitido, também é utilizado o modo de escrita configurado no Driver de
Comunicação. Para mais detalhes, consulte a documentação do Driver. Este método retorna um Booleano que indica o
sucesso ou não da operação.
WriteEx
WriteEx([Value], [Timestamp], [Quality], [WriteStatus], [WriteSyncMode])
Executa a escrita de um valor no equipamento. Todos os parâmetros são opcionais e, se omitidos, o comportamento
do método é igual ao do método Write. Este método retorna um Booleano que indica o sucesso ou não da
operação. O parâmetro Value define o valor a ser escrito no Driver de Comunicação. O tipo de dados depende do
Driver de Comunicação e, se omitido, assume o valor corrente do Elemento de Bloco de Comunicação. O parâmetro
Timestamp especifica a data e hora a ser escrita no Elemento de Bloco de Comunicação, se suportada pelo
equipamento. Se omitido, assume a data e hora do momento da operação de escrita. O parâmetro Quality indica a
qualidade, de 0 (zero) a 255. Se omitido, assume a qualidade Boa (192). O parâmetro WriteStatus recebe um valor
retornado pelo Driver de Comunicação, que indica o status da escrita, se suportado pelo Driver de Comunicação, de
acordo com a documentação própria. O parâmetro WriteSyncMode permite utilizar o modo de escrita diferente do
utilizado no Driver de Comunicação. As opções disponíveis para este parâmetro são 0: Usa o modo de escrita
configurado no Driver de Comunicação, 1: Executa uma escrita síncrona ou 2: Executa uma escrita assíncrona, sem
confirmação.
Se o parâmetro WriteSyncMode é omitido, também é utilizado o modo de escrita configurado no Driver de
Comunicação. O script a seguir contém um exemplo de uso deste método.
Sub Tag1_OnRead()
' O método WriteEx pode ser usado para transferir
' valores de variáveis de um driver para outro.
[Link]("[Link]")._
WriteEx Value, TimeStamp, Quality
End Sub

[Link].4.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Elemento de Bloco de Comunicação
(IOBlockElement).
Bit00 até Bit31
As propriedades de bit Bit00 até Bit31 representam juntas os 32 bits do valor presente na propriedade Value do
Elemento de Bloco de Comunicação, em que Bit00 é o bit menos significativo e Bit31 o bit mais significativo. Modificar
cada um destes bits implica na igual modificação da propriedade Value do Elemento de Bloco de Comunicação, e
vice-versa, mas isto somente ocorre quando a propriedade UseBitFields está configurada para Verdadeiro. O valor
padrão desta propriedade é Falso.
DeviceHigh
Esta propriedade define o valor máximo atingido pelo Elemento de Bloco de Comunicação no equipamento. Esta
propriedade é utilizada no cálculo do valor da propriedade PercentDeadBand, e também para executar o ajuste de
escala do valor proveniente do equipamento antes de ser atribuído à propriedade Value. Da mesma forma, no
momento da escrita é realizada a operação inversa antes de enviar o valor para o Driver de Comunicação. Esta
conversão só ocorre quando a propriedade EnableScaling está configurada para Verdadeiro. O valor padrão desta
propriedade é 1000.

NOTA
Os valores dos bits, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste na escala, ou seja,
representam os bits dos valores lidos pelo equipamento antes da conversão.

302 Objetos de Servidor

DeviceLow
Esta propriedade define qual o valor mínimo atingido por este Elemento de Bloco de Comunicação no equipamento.
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 antes de ser atribuído à propriedade Value. Da mesma forma, no
momento da escrita, é realizada a operação inversa antes de enviar o valor para o Driver de Comunicação. Esta
conversão só ocorre quando a propriedade EnableScaling está configurada para Verdadeiro. O valor padrão desta
propriedade é 0 (zero).

NOTA
Os valores dos bits, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste na escala, ou seja,
representam os bits dos valores lidos pelo equipamento antes 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 Elemento de Bloco de Comunicação. Se esta propriedade do Elemento de Bloco de
Comunicação está configurada para Verdadeiro, é habilitada a geração do evento OnTagRead por este Elemento de
Bloco de Comunicação. Caso contrário, não ocorre. O Tag de Comunicação, Bloco de Comunicação e Elemento de
Bloco de Comunicação podem gerar este evento. O evento ocorre no Driver de Comunicação e não no Elemento de
Bloco de Comunicação.
EnableScaling
Esta propriedade habilita ou desabilita a escala de valor para o valor enviado e recebido do equipamento. Se esta
propriedade está configurada para Verdadeiro, todo valor proveniente do equipamento 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. O script a seguir contém um exemplo de uso desta propriedade.
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 o valor representa, como por exemplo
graus, metros ou KW/h. O valor padrão desta propriedade é vazio. O script a seguir contém um exemplo de uso
desta propriedade.
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
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EUHigh
Define qual valor máximo deve ser atribuído à propriedade Value, ajustando a escala ao valor do equipamento
antes desta atribuição. Da mesma forma, no momento da escrita é realizada a operação inversa antes de enviar o
valor para o Driver de Comunicação. Esta conversão só ocorre quando a propriedade EnableScaling está configurada
para Verdadeiro. O valor padrão desta propriedade é 1000. O script a seguir contém um exemplo de uso desta
propriedade.
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

Objetos de Servidor 303

 DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EULow
Define qual valor mínimo deve ser atribuído à propriedade Value, ajustando a escala ao valor do equipamento
antes desta atribuição. Da mesma forma, no momento da escrita, é realizada a operação inversa antes de enviar o
valor para o Driver de Comunicação. Esta conversão só ocorre quando a propriedade EnableScaling está configurada
para Verdadeiro. O valor padrão desta propriedade é 0 (zero). O script a seguir contém um exemplo de uso desta
propriedade.
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
Index
Especifica a posição que o Elemento de Bloco de Comunicação ocupa entre os Elementos configurados pela
propriedade Size do Bloco de Comunicação no qual 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 para ter Size
igual a 20, o número máximo válido para esta propriedade é 19 e o mínimo é 0 (zero). Esta propriedade pode ser
alterada após iniciada a comunicação. O valor padrão desta propriedade é 0 (zero), porém ao mapear os Elementos
de Bloco de Comunicação de um Bloco de Comunicação o Elipse E3 Studio automaticamente ajusta o parâmetro
Index para um valor de acordo com o especificado. O script a seguir contém um exemplo de uso desta propriedade.
Sub Elemento_OnStartRunning()
Index = 15
End Sub
PercentDeadBand
Esta propriedade determina a variação mínima do valor ou banda morta de um Elemento de Bloco de Comunicação,
para que o valor no Elipse E3 seja atualizado. Este valor é especificado como um percentual da diferença entre as
propriedades DeviceHigh e DeviceLow. Esta propriedade só é utilizada caso a propriedade EnableDeadBand do
Bloco de Comunicação esteja configurada para Verdadeiro. Se esta propriedade é igual a 0 (zero), o Elemento de
Bloco de Comunicação não tem banda morta, e qualquer variação no valor é repassada para o Elipse E3. Caso
contrário, só é enviado para o Elipse E3 um novo valor cuja diferença, em relação ao valor atual no Elipse E3, seja
maior que a banda morta. O valor padrão desta propriedade é 0 (zero).
Quality
Esta propriedade informa qual a qualidade do valor contido na propriedade Value. Cada vez que o Driver de
Comunicação atribui um novo valor para o Elemento de Bloco de Comunicação, também é configurada a qualidade
daquele dado. Esta propriedade é somente de leitura. O valor padrão desta propriedade é 0 (zero, Qualidade Ruim).

NOTA
Para mais informações sobre qualidade, consulte o tópico Qualidade no Manual do Usuário do Elipse E3.

RawValue
Acessa o valor original do Elemento de Bloco de Comunicação anterior à escala, ou seja, independente da
configuração da propriedade EnableScaling. Portanto, se esta propriedade é igual a Falso, a propriedade Value e
esta propriedade apresentam o mesmo comportamento.
UseBitFields
Se esta propriedade está configurada para Verdadeiro, toda vez que o valor da propriedade Value é modificada,
atualiza os bits referentes às propriedades de 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 se a
propriedade AllowWrite do Bloco de Comunicação está 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.

304 Objetos de Servidor

Value
Atualizada sempre que uma nova leitura válida de um valor do equipamento é realizada, utilizando-se a
configuração B1 até B4 do Bloco de Comunicação onde este Elemento de Bloco de Comunicação está inserido, e
considerando-se a posição na tabela lida através da propriedade Index. O tipo de dados desta variável, um número
inteiro, ponto flutuante ou texto, depende do Driver de Comunicação ao qual o Elemento de Bloco de Comunicação
está associado e da configuração.
Esta propriedade somente é atualizada desta forma se a propriedade AllowRead do objeto Bloco de Comunicação
ao qual o Elemento de Bloco de Comunicação pertence está configurada para Verdadeiro, e quando não houver erros
de comunicação. Neste caso, somente as propriedades Quality e TimeStamp são atualizadas, de acordo com o
tempo de varredura definido em Scan. Outra forma de utilizar esta propriedade é para escrever valores no
equipamento. Para isto, atribua um novo valor à esta propriedade ou a alguma das propriedades de Bit00 até Bit31.
Neste caso, a propriedade AllowWrite do objeto Bloco de Comunicação deve estar configurada para Verdadeiro.
Esta também é a propriedade padrão do objeto Elemento de Bloco de Comunicação. Sendo assim, uma referência
por valor a um Elemento de Bloco de Comunicação não necessita obrigatoriamente explicitar esta propriedade para
acessar o valor. Caso esta propriedade não esteja sendo atualizada, verifique se a propriedade Index está
corretamente configurada. O valor padrão desta propriedade é vazio ou sem valor. O script a seguir contém um
exemplo de uso desta propriedade.
Sub Botao1_Click()
' Acessa um elemento e mostra o valor atual
' elm1 é um objeto tipo Bloco de comunicação
Set obj = [Link]("Driverde_
Comunicacao1.Block1.elm1")
MsgBox "Valor atual de elm1: " & [Link]
' 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

[Link] Pasta
Esta seção contém informações sobre as propriedades do objeto Pasta do Driver de Comunicação (IOFolder). Este
objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Pasta do Driver de Comunicação (IOFolder).

[Link].1.1 ParamDevice
Define o endereço do equipamento acessado pela Pasta. Esta propriedade é herdada do Driver de Comunicação e
o valor pode ser sobrescrito, se necessário.

[Link] Tag de Comunicação

Esta seção contém informações sobre eventos, métodos e propriedades do objeto Tag de Comunicação (IOTag).

[Link].1 Eventos
Esta seção contém informações sobre os eventos do objeto Tag de Comunicação (IOTag).

[Link].1.1 OnRead
OnRead()
Ocorre quando é efetuada uma leitura do Tag de Comunicação pelo Driver de Comunicação. Utilize este evento para
efetuar alguma operação logo após algum dado ser modificado no Tag de Comunicação, como por exemplo as
propriedades Value, Quality ou TimeStamp. Este evento é gerado por uma leitura em background. O script a seguir
contém um exemplo de uso deste evento.
Sub CommTag1_OnRead()
' Ao ler o tag, atribui o seu valor ao tag InternalTag1
Set obj = [Link]("DataServer1.InternalTag1")
obj = Value ' Valor de CommTag1
End Sub

Objetos de Servidor 305

[Link].2 Métodos
Esta seção contém informações sobre os métodos do objeto Tag de Comunicação (IOTag).

[Link].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 é igual a Falso. O parâmetro WriteSyncMode permite
utilizar o modo de escrita diferente do utilizado no Driver de Comunicação. As opções disponíveis para este
parâmetro são 0: Usa o modo de escrita configurado no Driver de Comunicação, 1: Executa uma escrita síncrona ou 2:
Executa uma escrita assíncrona, sem confirmação.
Se o parâmetro WriteSyncMode é omitido, também é utilizado o modo de escrita configurado no Driver de
Comunicação. Para mais detalhes, consulte a documentação do Driver. Este método retorna um Booleano que indica o
sucesso ou não da operação.

[Link].2.2 WriteEx

WriteEx([Value], [Timestamp], [Quality], [WriteStatus], [WriteSyncMode])

Executa a escrita de um valor no equipamento. Todos os seus parâmetros são opcionais e, se omitidos, o
comportamento do método é igual ao do método Write. Este método retorna um Booleano que indica o sucesso ou
não da operação.
O parâmetro Value define o valor a ser escrito no Driver de Comunicação. O tipo de dados depende do Driver de
Comunicação e, se omitido, assume o valor corrente do Tag de Comunicação. Timestamp especifica a data e hora a
ser escrita no Tag de Comunicação, se suportada pelo equipamento. Se omitido, assume a data e hora do momento
da operação de escrita. Quality indica a qualidade, de 0 (zero) a 255. Se omitido, assume a qualidade Boa (192). O
parâmetro WriteStatus recebe um valor retornado pelo Driver de Comunicação, que indica o status da escrita, se
suportado, de acordo com a documentação própria. O parâmetro WriteSyncMode permite utilizar o modo de escrita
diferente do utilizado no Driver de Comunicação. As opções disponíveis para este parâmetro são 0: Usa o modo de
escrita configurado no Driver de Comunicação, 1: Executa uma escrita síncrona ou 2: Executa uma escrita assíncrona,
sem confirmação.
Se o parâmetro WriteSyncMode é omitido, também é utilizado o modo de escrita configurado no Driver de
Comunicação. O script a seguir contém um exemplo de uso deste método.
Sub Tag1_OnRead()
' O método WriteEx pode ser usado para transferir
' valores de variáveis de um driver para outro.
[Link]("[Link]")._
WriteEx Value, TimeStamp, Quality
End Sub

[Link].3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Tag de Comunicação (IOTag).

[Link].3.1 AdviseType
Controla o modo Advise. As opções disponíveis estão descritas na tabela a seguir.
Opções disponíveis para a propriedade AdviseType
OPÇÃO DESCRIÇÃO
0 - AlwaysInAdvise O Tag de Comunicação é mantido atualizado se a
propriedade AllowRead é igual a Verdadeiro

1 - AdviseWhenLinked O Tag de Comunicação só é atualizado se AllowRead é

igual a Verdadeiro e o Tag de Comunicação está
associado a algum objeto ativo, por exemplo um Display
de uma Tela aberta ou um Alarme habilitado, entre
outros. A associação do Tag de Comunicação para este
propósito pode ser realizada nas propriedades Value,
RawValue, TimeStamp, Quality e de Bit00 até Bit31 do
Tag de Comunicação (padrão)

306 Objetos de Servidor

O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton3_Click()
MsgBox Application._
[Link]("Driver1.Tag1").AdviseType
End Sub

[Link].3.2 AllowRead
Configure esta propriedade para definir se este Tag de Comunicação deve ou não ser lido pelo Driver de
Comunicação. Se esta propriedade está configurada para Verdadeiro, o Driver de Comunicação automaticamente
atualiza as propriedades Value, de Bit00 até Bit31 e RawValue deste objeto em intervalos de tempo definidos pela
propriedade Scan. Caso contrário, este Tag de Comunicação não é lido. O valor padrão desta propriedade é
Verdadeiro. O script a seguir contém um exemplo de uso desta propriedade.
Sub Botao1_Click()
' Faz com que seja parada a leitura do tag
Set obj = [Link]("[Link]")
[Link] = False
End Sub

[Link].3.3 AllowWrite
Configure esta propriedade para definir se este Tag de Comunicação deve ou não ser escrito automaticamente
quando as propriedades Value, qualquer uma das propriedades de Bit00 até Bit31 ou RawValue são modificadas.
Se esta propriedade está configurada para Verdadeiro, as modificações são enviadas para o equipamento associado
ao Driver de Comunicação. Caso contrário, as modificações são ignoradas. O valor padrão desta propriedade é
Verdadeiro. O script a seguir contém um exemplo de uso desta propriedade.
Sub Botao1_Click()
' Faz com que seja desabilitada a escrita do tag
Set obj = [Link]("[Link]")
[Link] = False
End Sub

[Link].3.4 Bit00 até Bit31

As propriedades de bit Bit00 até Bit31 representam juntas os 32 bits do valor presente na propriedade Value do
objeto Tag de Comunicação, em que Bit00 é o bit menos significativo e Bit31 o bit mais significativo. Modificar cada
um destes bits implica na igual modificação da propriedade Value do Tag de Comunicação, e vice-versa, mas isto
somente ocorre quando a propriedade UseBitFields está configurada para Verdadeiro. O valor padrão desta
propriedade é Falso.

[Link].3.5 DeviceHigh
Esta propriedade define qual o valor máximo atingido pelo Tag de Comunicação no equipamento. Esta propriedade
é utilizada para executar o ajuste de escala do valor proveniente do equipamento antes de ser atribuído à
propriedade Value. Da mesma forma, no momento da escrita é realizada a operação inversa antes de enviar o valor
para o Driver de Comunicação. Esta conversão só ocorre quando a propriedade EnableScaling está configurada para
Verdadeiro. O valor padrão desta propriedade é 1000. O script a seguir contém um exemplo de uso desta
propriedade.
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 valores dos bits, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é, representam
os bits do valor lido do equipamento antes da conversão.

Objetos de Servidor 307

[Link].3.6 DeviceLow
Esta propriedade define o valor mínimo atingido por este Tag de Comunicação no equipamento. Esta propriedade é
utilizada para executar o ajuste de escala do valor proveniente do equipamento antes de ser atribuído à propriedade
Value. Da mesma forma, no momento da escrita é realizada a operação inversa antes de enviar o valor para o Driver
de Comunicação. Esta conversão só ocorre quando a propriedade EnableScaling está configurada para Verdadeiro.
O script a seguir contém um exemplo de uso desta propriedade.
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 valores dos bits, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é, representam
os bits do valor lido do equipamento antes da conversão.

[Link].3.7 EnableDeadBand
Esta propriedade habilita ou desabilita a propriedade PercentDeadBand. Se esta propriedade está configurada
para Verdadeiro, o valor do Tag de Comunicação é atualizado somente se este mudar e o novo valor exceder o limite
definido pela propriedade PercentDeadBand. Caso contrário, o Tag de Comunicação é sempre atualizado e o limite
de banda morta não é verificado. Sempre mantenha a banda morta habilitada, pois melhora a performance da
aquisição de dados e processamento. Deve-se desabilitar a banda morta somente em casos onde o Driver de
Comunicação está retornando eventos de Tags Digitais ou Analógicos, e seja necessário processar estes eventos via
script no evento OnRead do Tag de Comunicação. O valor padrão desta propriedade é Verdadeiro.

[Link].3.8 EnableDriverEvent
Esta propriedade é utilizada para controlar a geração do evento OnTagRead, que ocorre no Driver de
Comunicação que contém este Tag de Comunicação. Se esta propriedade do Tag de Comunicação está configurada
para Verdadeiro, é habilitada a geração do evento OnTagRead por este Tag de Comunicação. Caso contrário, não
ocorre. O Tag de Comunicação, Bloco de Comunicação e Elemento de Bloco de Comunicação podem gerar este
evento. O evento ocorre no Driver de Comunicação e não no Tag de Comunicação.

[Link].3.9 EnableScaling
Esta propriedade habilita ou desabilita a escala de valor para o valor enviado e recebido do equipamento. Se esta
propriedade está configurada para Verdadeiro, todo valor proveniente do equipamento sofre ajuste de escala nas
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 script a seguir contém um
exemplo de uso desta propriedade.
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

[Link].3.10 EU
Esta propriedade é utilizada para identificar a unidade de engenharia que o valor representa, como por exemplo
graus, metros ou KW/h. O valor padrão desta propriedade é vazio. O script a seguir contém um exemplo de uso
desta propriedade.

308 Objetos de Servidor

 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

[Link].3.11 EUHigh
Define qual o valor máximo que deve ser atribuído à propriedade Value, ajustando a escala ao valor do
equipamento antes desta atribuição. Da mesma forma, no momento da escrita é realizada a operação inversa antes
de enviar o valor para o Driver de Comunicação. Esta conversão só ocorre quando a propriedade EnableScaling está
configurada para Verdadeiro. O valor padrão desta propriedade é 1000. O script a seguir contém um exemplo de uso
desta propriedade.
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 valores dos bits, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é, representam
os bits do valor lido do equipamento antes da conversão.

[Link].3.12 EULow
Define qual o valor mínimo que deve ser atribuído à propriedade Value, ajustando a escala ao valor do
equipamento antes desta atribuição. Da mesma forma, no momento da escrita, é realizada a operação inversa antes
de enviar o valor para o Driver de Comunicação. Esta conversão só ocorre quando a propriedade EnableScaling está
configurada para Verdadeiro. O valor padrão desta propriedade é 0 (zero). O script a seguir contém um exemplo de
uso desta propriedade.
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 valores dos bits, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é, representam
os bits do valor lido do equipamento antes da conversão.

[Link].3.13 N1
Especifica a variável do equipamento a que este Tag de Comunicação está associado. Consulte a documentação do
Driver para a correta configuração. Esta propriedade pode ser modificada após iniciada a comunicação. O valor
padrão desta propriedade é 0 (zero). O script a seguir contém um exemplo de uso desta propriedade.
Sub Tag_OnStartRunning()
N1 = 10
End Sub

Objetos de Servidor 309

[Link].3.14 N2
Especifica a variável do equipamento a que este Tag de Comunicação está associado. Consulte a documentação do
Driver para a correta configuração. Esta propriedade pode ser modificada após iniciada a comunicação. O valor
padrão desta propriedade é 0 (zero). O script a seguir contém um exemplo de uso desta propriedade.
Sub Tag_OnStartRunning()
N2 = 3
End Sub

[Link].3.15 N3
Especifica a variável do equipamento a que este Tag de Comunicação está associado. Consulte a documentação do
Driver para a correta configuração. Esta propriedade pode ser modificada após iniciada a comunicação. O valor
padrão desta propriedade é 0 (zero). O script a seguir contém um exemplo de uso desta propriedade.
Sub Tag_OnStartRunning()
N1 = 10
N3 = 5
N4 = 20
End Sub

[Link].3.16 N4
Especifica a variável do equipamento a que este Tag de Comunicação está associado. Consulte a documentação do
Driver para a correta configuração. Esta propriedade pode ser modificada após iniciada a comunicação. O valor
padrão desta propriedade é 0 (zero). O script a seguir contém um exemplo de uso desta propriedade.
Sub Tag_OnStartRunning()
N1 = 10
N4 = 20
End Sub

[Link].3.17 ParamDevice
Define o endereço do equipamento acessado por este Tag de Comunicação. Esta propriedade é herdada do Driver
de Comunicação, mas o valor pode ser sobrescrito, se necessário.

[Link].3.18 ParamItem
Identifica o dado que este Tag de Comunicação acessa em um equipamento.

[Link].3.19 PercentDeadBand
Esta propriedade determina a variação mínima do valor ou banda morta de um Tag de Comunicação, para que o
valor no Elipse E3 seja atualizado. Este valor é especificado como um percentual da diferença entre as propriedades
DeviceHigh e DeviceLow. Esta propriedade só é utilizada caso a propriedade EnableDeadBand do mesmo Tag de
Comunicação esteja configurada para Verdadeiro. Se esta propriedade é igual a 0 (zero), o Tag de Comunicação não
tem banda morta, e qualquer variação no valor é repassada para o Elipse E3. Caso contrário, só é enviado para o
Elipse E3 um novo valor cuja diferença, em relação ao valor atual no Elipse E3, seja maior que a banda morta. O valor
padrão desta propriedade é 0 (zero).

[Link].3.20 Quality
Esta propriedade informa qual a qualidade do valor contido na propriedade Value. Cada vez que o Driver de
Comunicação atribui um novo valor para o Tag de Comunicação, também é configurada a qualidade daquele dado.
Esta propriedade é somente de leitura. O valor padrão desta propriedade é 0 (zero, Qualidade Ruim).

NOTA
Para mais informações sobre qualidade, consulte o tópico Qualidade no Manual do Usuário do Elipse E3.

[Link].3.21 RawValue
Acessa o valor original do Tag de Comunicação anterior à escala, ou seja, independente da configuração da
propriedade EnableScaling. Portanto, se esta propriedade é igual a Falso, a propriedade Value e esta propriedade
apresentam o mesmo comportamento.

310 Objetos de Servidor

[Link].3.22 Scan
Utilize esta propriedade para especificar o tempo de varredura que é utilizado pelo servidor para atualizar a
propriedade Value. Esta propriedade é representada em milissegundos, pode ser modificada após iniciada a
comunicação e é utilizada apenas quando a propriedade AllowRead está configurada para Verdadeiro. Ao configurar
esta propriedade nos diversos Tags de Comunicação presentes em uma aplicação, recomenda-se aumentar o valor
desta propriedade para aqueles Tags de Comunicação que não variam muito no equipamento, possibilitando assim
que outros Tags de Comunicação de maior prioridade sejam lidos com maior frequência, aumentando assim a
performance geral do sistema. O valor padrão desta propriedade é 1000, ou um segundo. O valor do scan deve ser
maior que 0 (zero). O script a seguir contém um exemplo de uso desta propriedade.
Sub Tag_OnStartRunning()
Scan = 1500
End Sub

[Link].3.23 TimeStamp
Esta propriedade é atualizada sempre que ocorrer alguma mudança de valor ou 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. Esta é uma propriedade somente para leitura. O valor padrão desta propriedade é "00:00:00".

[Link].3.24 UseBitFields
Caso esta propriedade esteja configurada para Verdadeiro, toda vez que o valor da propriedade Value é
modificado, atualiza os bits referentes às propriedades de Bit00 até Bit31. Da mesma forma, atualiza o valor de
Value toda vez que alguma das propriedades de Bit00 até Bit31 mudar de valor e posteriormente envia para o
equipamento, se a propriedade AllowWrite está 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.

NOTA
Os valores dos bits, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é, representam
os bits do valor lido do equipamento antes da conversão.

[Link].3.25 Value
Atualizada sempre que uma nova leitura válida de um valor do equipamento é executada, utilizando-se a
configuração dos parâmetros de N1 até N4. O tipo de dados desta variável, um número inteiro, ponto flutuante ou
texto, depende do Driver de Comunicação ao qual o Tag de Comunicação está associado e da configuração.
Esta propriedade somente é atualizada desta forma se a propriedade AllowRead está configurada para Verdadeiro, e
quando não houver erros de comunicação. Neste caso, somente as propriedades Quality e TimeStamp são
atualizadas, de acordo com o tempo de varredura definido em Scan. Outra forma de utilizar esta propriedade é para
escrever valores no equipamento. Para isto, atribua um novo valor à esta propriedade ou a alguma das propriedades
de Bit00 até Bit31. Neste caso, a propriedade AllowWrite deve estar configurada para Verdadeiro.
Esta também é a propriedade padrão do objeto Tag de Comunicação. Sendo assim, uma referência por valor a um
Tag de Comunicação não necessita obrigatoriamente explicitar esta propriedade para acessar o valor. O valor padrão
desta propriedade é vazio. O script a seguir contém um exemplo de uso desta propriedade.
Sub Botao1_Click()
' Acessa um tag e mostra o valor atual
' tag1 é um objeto tipo Tag de Comunicação
Set obj = [Link]("Driver de Comunicação1._
tag1")
MsgBox "Valor atual de tag1: " & [Link]
' Isto também pode ser feito de outra forma,
' sem mostrar a propriedade Value, que é o padrão
MsgBox "Valor atual de tag1: " & obj
End Sub

NOTA
Os valores dos bits, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é, representam
os bits do valor lido do equipamento antes da conversão.

Objetos de Servidor 311

5.5.2 Driver de Comunicação OPC
Esta seção contém informações sobre eventos e propriedades do objeto Driver de Comunicação OPC (OPCDriver).
Este objeto não possui métodos associados.

[Link] Eventos
Esta seção contém informações sobre os eventos do objeto Driver de Comunicação OPC (OPCDriver).

[Link].1 OnTagRead
OnTagRead(Tag)
Ocorre na leitura de um Tag de Comunicação OPC, sempre que um novo valor ou erro é retornado pelo Servidor
OPC, ou seja, se o valor ou a qualidade do Tag de Comunicação OPC não mudarem, o evento não é disparado. Para
que este evento ocorra, a propriedade EnableDriverEvent do Tag de Comunicação OPC deve obrigatoriamente estar
habilitada.

[Link].2 OnTagWrite
OnTagWrite(Tag, Succeeded, User)
Ocorre quando uma escrita é disparada em qualquer Tag de Comunicação OPC do Driver de Comunicação OPC. Para
que este evento ocorra, a propriedade EnableDriverEvent do Tag de Comunicação OPC deve obrigatoriamente estar
habilitada. Se a escrita é assíncrona, este evento é gerado apenas quando o Servidor OPC enviar a resposta indicando
o efetivo sucesso ou não da escrita.
Parâmetros do evento OnTagWrite
NOME DESCRIÇÃO
Tag Uma referência para o objeto Tag de Comunicação OPC
que está sofrendo a escrita. Por exemplo, pode-se
acessar a propriedade do Tag de Comunicação OPC
usando a sintaxe [Link]

Succeeded Um valor Booleano que indica sucesso ou falha na escrita

User Parâmetro que recebe o usuário que executou a escrita.

O valor padrão deste parâmetro é "System". Se não há
nenhum usuário logado no Elipse E3 Viewer que gerou
o evento, este parâmetro contém o valor "Anonymous".
Se a escrita é assíncrona ou se ocorreu uma falha
reportada de forma assíncrona, este parâmetro sempre
contém o valor "System"

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Driver de Comunicação OPC (OPCDriver).

[Link].1 ActiveServer
Esta propriedade indica o Servidor OPC ativo em um determinado momento, que pode ser tanto o servidor
indicado na propriedade ServerMachine (principal) quanto na propriedade ServerMachine2 (redundante). Esta
propriedade é somente de leitura.

[Link].2 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 de Comunicação OPC e mudança no modo
Advise dos Tags de Comunicação OPC, entre outros. Caso este tempo seja excedido, o Elipse E3 considera o Servidor
OPC como travado ou 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, de forma que acessos ao
Servidor OPC podem demorar um tempo indefinido, eventualmente travando toda a aplicação caso este acesso seja
síncrono. O valor padrão desta propriedade é 10000, ou 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.

312 Objetos de Servidor

[Link].3 Compatibility
Permite controlar o uso das interfaces padrão OPC pelo Cliente OPC do Elipse E3. Os valores possíveis para esta
propriedade são:
· 0 - AnyVersion: Funcionamento normal, padrão e recomendado, em que um Driver de Comunicação OPC
comunica com Servidores DA 2.0x e 1.0a, com preferência ao uso de interfaces 2.0x
· 1 - Version10A: Permite forçar a comunicação no padrão DA 1.0a para Servidores OPC 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 está habilitada, tanto no Elipse E3
Studio quanto em tempo de execução.

NOTA
Apenas em último caso um Driver de Comunicação OPC deve ser configurado com um valor diferente de 0 -
AnyVersion. Esta propriedade é de uso avançado, e se aplica restritamente para contornar alguma situação de
possível incompatibilidade com algum Servidor OPC específico.

[Link].4 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 OPC 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, de forma 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 desta propriedade é 10000, ou 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.

[Link].5 ReconnectPeriod
Controla o período da conexão com um Servidor OPC. Se a conexão é perdida, o Driver de Comunicação OPC para
e reinicia até que esta ação retorne sucesso. O período é configurado em milissegundos e quando o valor é
configurado para 0 (zero), a reconexão é desabilitada. Pelo fato do Driver de Comunicação OPC ser parado e iniciado,
os eventos BeforeStart e AfterStop são gerados. Quando a conexão é perdida, todos os Tags de Comunicação OPC
relacionados são desconectados do estado atual (bad/quality/null value). O script a seguir contém um exemplo de uso
desta propriedade.
Sub DriverOPC1_AfterStart()
[Link]("DriverOPC1.GrupoOPC1")._
ReconnectPeriod = 0
End Sub

[Link].6 ServerId
Determina o Servidor OPC ao qual o Driver de Comunicação OPC deve se conectar. Apesar de o valor padrão desta
propriedade ser vazio, se este valor está vazio o Driver de Comunicação OPC não se conecta. Esta propriedade só
pode ser modificada quando o Driver de Comunicação OPC não está conectado. O script a seguir contém um
exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set Opc = [Link]("DriverOPC1")
[Link]
[Link] = "[Link].1"
[Link] = "\\server2"
[Link]
End Sub

[Link].7 ServerMachine
Esta propriedade determina o endereço da estação onde está executando o Servidor OPC principal. Para aplicações
que estão executando localmente, esta propriedade pode permanecer em branco (padrão). Caso contrário, é
necessário especificar o caminho, como por exemplo "\\NomeServidor". Caso o Servidor OPC indicado nesta
propriedade retorne um valor diferente de 1 (um, ServerStatus_Running) na propriedade ServerStatus, o Driver de
Comunicação OPC tenta a conexão com o Servidor OPC indicado na propriedade ServerMachine2, se aquela
propriedade não é um valor vazio e se o valor da propriedade ServerStatus daquele Servidor OPC é igual a 1 (um,

Objetos de Servidor 313

ServerStatus_Running). Esta propriedade só pode ser modificada quando o Driver de Comunicação OPC está
desconectado. O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Set Opc = [Link]("DriverOPC1")
[Link]
[Link] = "[Link].1"
[Link] = "\\server2"
[Link]
End Sub

[Link].8 ServerMachine2
Esta propriedade determina o endereço da estação onde está executando o Servidor OPC redundante, para os
casos em que a conexão com o Servidor OPC indicado na propriedade ServerMachine falha ou demora um tempo
maior do que o especificado na propriedade ConnectionTimeout. A conexão com este Servidor OPC redundante só
é possível se a propriedade ServerStatus é igual a 1 (um, ServerStatus_Running).

[Link].9 ServerName
Esta propriedade retorna o nome ou a descrição do Servidor OPC. Esta propriedade é diferente da propriedade
ServerID, que é um código. Esta propriedade é somente de leitura. O script a seguir contém um exemplo de uso
desta propriedade.
Sub Driver OPC1_AfterStart()
MsgBox _
[Link]("DriverOPC1.GrupoOPC1").ServerName
End Sub

[Link].10 ServerStatus
Determina o estado da conexão com um Servidor OPC. Esta propriedade é somente de leitura. As opções
disponíveis estão descritas na tabela a seguir.
Opções disponíveis para a propriedade ServerStatus
OPÇÃO DESCRIÇÃO
-1 - ServerStatus_Unknown O Driver de Comunicação OPC está conectado ao
Servidor OPC mas o estado não é informado ou o Cliente
OPC está com a propriedade ReconnectPeriod
configurada em 0 (zero, padrão)

0 - ServerStatus_NotConnected O Driver de Comunicação OPC não está conectado ao

Servidor OPC. Isto acontece quando, por exemplo, o
Driver de Comunicação OPC não está ativo, ou a conexão
não foi estabelecida por algum problema qualquer

Os valores a seguir são informados apenas quando a propriedade ReconnectPeriod é diferente de 0 (zero). Esta
passagem de período especificando o estado é buscada no Servidor OPC. Caso o estado não seja informado
corretamente, esta propriedade pode manter o valor igual a -1 (menos um), ou a desconexão pode ser detectada
neste caso, levando esta propriedade para 0 (zero). Os valores são baseados nos cinco estados padrão definidos
para Servidores OPC.
Opções disponíveis para ReconnectPeriod diferente de 0 (zero)
OPÇÃO DESCRIÇÃO
1 - ServerStatus_Running O Servidor OPC está executando normalmente

2 - ServerStatus_Failed O Servidor OPC não está executando. Um erro não

especificado ocorreu no Servidor OPC

3 - ServerStatus_NoConfig O Servidor OPC está executando, porém sem

informações de configuração

4 - ServerStatus_Suspended O Servidor OPC foi suspenso temporariamente

5 - ServerStatus_Test O Servidor OPC está em modo de teste

O script a seguir contém um exemplo de uso desta propriedade.

314 Objetos de Servidor

 Sub CommandButton1_Click()
Dim status
status = [Link]("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
Para obter o comportamento equivalente a uma propriedade Booleana, o recomendado é usar esta propriedade
diferente de 0 (zero). Isto basicamente diferencia apenas entre haver a conexão ou não, desconsiderando estados
mais específicos do Servidor OPC. Além disto, a expressão independe do uso da propriedade ReconnectPeriod
diferente de 0 (zero).

[Link].11 WriteFeedbackMode
Esta propriedade permite controlar a confirmação ou feedback das escritas em Tags de Comunicação OPC. As
opções de configuraçã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 escrita, aguarda normalmente a próxima leitura,
que é o padrão para aplicações criadas antes da
implementação desta propriedade

1 - wfImmediateReadAfterWrite Força uma leitura assíncrona de dispositivo logo após

cada escrita, que é o padrão para aplicações criadas a
partir da implementação desta propriedade

2 - wfTrustWriteSuccess O valor escrito é assumido pelo Tag de Comunicação

OPC imediatamente, caso a escrita tenha funcionado

NOTAS
· Esta propriedade do Driver de Comunicação OPC não pode ser alterada com o objeto ativo.
· Na opção 2 - wfTrustWriteSuccess, no caso de escritas assíncronas, o valor é assumido no Tag de Comunicação
OPC após o agendamento da escrita, se a operação é bem-sucedida. Porém, se a escrita falha posteriormente, o
valor no Tag de Comunicação OPC pode estar errado. No caso da escrita síncrona, o valor é assumido logo após
o término da escrita, se bem-sucedida.
· Consulte também a propriedade WriteFeedbackMode do objeto Driver de Comunicação, cujo comportamento é
semelhante.

[Link] Grupo OPC

Esta seção contém informações sobre métodos e propriedades do objeto Grupo OPC (OPCGroup). Este objeto não
possui eventos associados.

[Link].1 Métodos
Esta seção contém informações sobre os métodos do objeto Grupo OPC (OPCGroup).

Objetos de Servidor 315

[Link].1.1 Refresh

Refresh(Source)
Força o servidor a reenviar os valores de todos os Tags de Comunicação OPC do Grupo OPC que estejam com a
leitura habilitada, tenham estes 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 é igual a 1 (um, RefreshFromCache), os valores enviados
são os valores do cache do Servidor OPC. Do contrário, se o valor informado é igual a 2 (dois, RefreshFromDevice),
os valores enviados são atualizados no cache do Servidor OPC 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 de Comunicação OPC do
Grupo OPC, deve estar habilitada. Para mais informações sobre o mecanismo de habilitação de leitura, o modo
Advise, consulte as propriedades AllowRead e AdviseType do Tag de Comunicação OPC.

[Link].2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Grupo OPC (OPCGroup).

[Link].2.1 BlockMode
Esta propriedade determina o comportamento de ativação ou desativação do Grupo OPC. Quando esta
propriedade está configurada para Verdadeiro, a comunicação dos Tags de Comunicação OPC do Grupo OPC é
iniciada em conjunto. Isto em geral ocasiona uma melhor performance, ou seja, um menor tempo de ativação, por
minimizar o número de chamadas ao Servidor OPC. Quando esta propriedade está configurada para Falso, o
comportamento é de ativar a comunicação de cada Tag de Comunicação OPC do Grupo OPC individualmente, de
acordo com a sequência normal de ativação dos objetos. Com isto, por exemplo, o primeiro Tag de Comunicação
OPC do Grupo OPC, na ordem vista no Organizer, comunica antes do último Tag de Comunicação OPC. Apesar de
mais lento, pode ser uma vantagem usar este modo de ativação do Bloco de Comunicação OPC quando se deseja
executar alguma operação, como por exemplo uma escrita no Tag de Comunicação OPC, em um script do evento
OnStartRunning do Tag de Comunicação OPC. A desativação ocorre de maneira análoga. Quando o valor da
propriedade é Verdadeiro, a desativação da comunicação dos Tags de Comunicação OPC do Grupo OPC ocorre em
conjunto, ao término da desativação de todo o Grupo OPC. Caso a propriedade esteja configurada para Falso, a
desativação da comunicação ocorre individualmente para cada Tag de Comunicação OPC, de acordo com a sequência
normal de desativação de objetos.

[Link].2.2 DeadBand
Esta propriedade permite ajustar o nível mínimo de variação de um Tag de Comunicação OPC, para que este seja
atualizado. Essa propriedade só se aplica aos Tags de Comunicação OPC do Grupo OPC 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 (zero) e 100%. Um valor 0 (zero) para esta propriedade significa que qualquer variação do
valor de um Tag de Comunicação OPC do Grupo OPC implica na atualização do Grupo OPC. Este valor percentual é
aplicado para cada Tag de Comunicação OPC em relação aos limites de engenharia, que estão definidos no Servidor
OPC. Para que um Tag de Comunicação OPC seja atualizado, a seguinte expressão deve ser verdadeira, que é avaliada
no Servidor OPC:
Abs(Valor_guardado_anteriormente – Valor_corrente) > (DeadBand / 100) * Abs(Limite_Superior –
Limite_Inferior)

O valor padrão desta propriedade é 0 (zero).

[Link].2.3 Enable
Esta propriedade habilita a atualização dos Tags de Comunicação OPC dentro de um Grupo OPC. Se esta
propriedade está configurada para Falso, nenhum Tag de Comunicação OPC dentro do Grupo OPC é atualizado. Caso
contrário, os Tags de Comunicação OPC que tenham a propriedade AllowRead configurada para Verdadeiro e que
estejam em modo Advise são mantidos atualizados de acordo com o tempo de atualização, a propriedade Scan, e a
banda morta, a propriedade DeadBand, do Grupo OPC. Para mais informações, consulte a propriedade AdviseType.
Se esta propriedade está configurada para Falso, não é possível utilizar o método Refresh do Grupo OPC.

[Link].2.4 RealScan
Tempo de varredura efetivamente utilizado pelo Servidor OPC. Esta propriedade é somente de leitura.

316 Objetos de Servidor

[Link].2.5 Scan
Especifica o tempo de varredura de atualização dos Tags de Comunicação OPC do Grupo OPC que é utilizado pelo
Servidor OPC. Esta propriedade é representada em milissegundos, pode ser modificada após iniciada a comunicação,
e é utilizada apenas quando a propriedade Enable está configurada para Verdadeiro. Ao configurar esta propriedade
nos diversos Tags de Comunicação OPC presentes em uma aplicação, recomenda-se aumentar o valor desta
propriedade para aqueles Grupos OPC de Tags de Comunicação OPC que não variam muito no equipamento ou
dispositivo, possibilitando assim que outros Grupos OPC de Tags de Comunicação OPC de maior prioridade sejam
lidos com maior frequência, aumentando assim a performance e a resposta da aplicação. O valor padrão desta
propriedade é 1000.

[Link].3 Bloco de Comunicação OPC

Esta seção contém informações sobre eventos, métodos e propriedades do objeto Bloco de Comunicação OPC
(OPCTagBlock).

[Link].3.1 Eventos
Esta seção contém informações sobre os eventos do objeto Bloco de Comunicação OPC (OPCTagBlock).
OnRead
OnRead()
Ocorre quando um valor do Bloco de Comunicação OPC é recebido do Servidor OPC. Utilize este evento ao efetuar
alguma operação logo após algum dado ter sido modificado no objeto Bloco de Comunicação OPC, nas
propriedades Bit00 até Bit31, Quality, RawValue, TimeStamp e Value de algum Elemento do Bloco de Comunicação
OPC.

[Link].3.2 Métodos
Esta seção contém informações sobre os métodos do objeto Bloco de Comunicação OPC (OPCTagBlock).
Write
Write()
Executa a escrita do valor corrente do Bloco de Comunicação OPC em um equipamento. Para mais detalhes, consulte a
documentação do Driver. Este método retorna um Booleano que indica o sucesso ou não desta operação.
WriteEx
WriteEx([Value], [SyncWrite])
Executa a escrita de um valor em um equipamento. Todos os parâmetros são opcionais. Se omitidos, o
comportamento do método é igual ao do método Write. Este método retorna um Booleano que indica o sucesso ou
não desta operação. O parâmetro Value define o valor a ser escrito no Driver de Comunicação OPC. O tipo de dados
depende do Driver. Se omitido, assume o valor corrente do Bloco de Comunicação OPC. O parâmetro SyncWrite é um
Booleano que especifica se a operação descrita deve ser síncrona (Verdadeiro) ou assíncrona (Falso). Se omitido, usa
o valor especificado na propriedade SyncWrite do Bloco de Comunicação OPC.

NOTA
Assim como no método Write, a escrita é realizada independente de o valor ser diferente do valor atual do Bloco de
Comunicação OPC, bem como independente da propriedade AllowWrite do Bloco de Comunicação OPC estar
configurada para Verdadeiro ou Falso. Além disto, se a escrita funciona mas o Bloco de Comunicação OPC não está
em scan, seja porque a propriedade AllowRead está configurada para Falso ou porque usa a opção
AdviseWhenLinked quando não está associado, o valor escrito é assumido imediatamente com qualidade boa e
estampa de tempo do momento da escrita.

[Link].3.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Bloco de Comunicação OPC (OPCTagBlock).
AdviseType
Controla o modo Advise. As opções disponíveis estão descritas na tabela a seguir.

Objetos de Servidor 317

 Opções disponíveis para a propriedade AdviseType
OPÇÃO DESCRIÇÃO
0 - AlwaysInAdvise O Bloco de Comunicação OPC é mantido atualizado se a
propriedade AllowRead do Bloco de Comunicação OPC
está configurada para Verdadeiro e a propriedade
Enable do Grupo OPC também está configurada para
Verdadeiro

1 - AdviseWhenLinked O Bloco de Comunicação OPC só é atualizado se a

propriedade AllowRead do Bloco de Comunicação OPC
e a propriedade Enable do Grupo OPC estão
configuradas para Verdadeiro, e o Bloco de
Comunicação OPC está associado a algum objeto ativo,
como por exemplo um Display de uma Tela aberta ou
um Alarme habilitado, entre outros. A associação do
Bloco de Comunicação OPC para este propósito pode
ser realizada nas propriedades Value, RawValue,
Quality e de Bit00 até Bit31 de Elementos de Bloco de
Comunicação OPC, e Quality e TimeStamp de Blocos de
Comunicação OPC (padrão)

O script a seguir contém um exemplo de uso desta propriedade.

Sub CommandButton3_Click()
MsgBox Application._
GetObject("[Link].SCRIPT1").AdviseType
End Sub
AllowRead
Configure esta propriedade para definir se este Bloco de Comunicação OPC deve ou não ser lido pelo Driver de
Comunicação OPC. Se esta propriedade está configurada para Verdadeiro, então o Driver de Comunicação OPC
automaticamente atualiza as propriedades Value e de Bit00 até Bit31, dos Elementos do Bloco de Comunicação OPC
em intervalos de tempo. Caso contrário, este Bloco de Comunicação OPC não é lido se esta propriedade está
configurada para Falso. O valor padrão desta propriedade é Verdadeiro. O script a seguir contém um exemplo de
uso desta propriedade.
Sub Botao1_Click()
' Faz com que seja parada a leitura do Tag
Set obj = [Link]("[Link]")
[Link] = False
End Sub
AllowWrite
Configure esta propriedade para definir se este Bloco de Comunicação OPC deve ou não ser escrito
automaticamente quando a propriedade Value ou qualquer uma das propriedades de Bit00 até Bit31, é modificada.
Se a propriedade está em Verdadeiro, as modificações são enviadas para o equipamento ou dispositivo associado ao
Driver de Comunicação OPC, senão as modificações são ignoradas. Se esta propriedade está configurada para
Verdadeiro, então o Driver de Comunicação OPC automaticamente atualiza as propriedades Value e de Bit00 até
Bit31, deste objeto, em intervalos de tempo. Caso contrário, este Bloco de Comunicação OPC não é lido. O valor
padrão desta propriedade é Verdadeiro. O script a seguir contém um exemplo de uso desta propriedade.
Sub Botao1_Click()
Set obj = [Link]("[Link]")
[Link] = False
End Sub
DataType
Determina o tipo de dados associado ao Bloco de Comunicação OPC. Esta propriedade é somente de leitura. Os
valores possíveis para esta propriedade estão descritos na tabela a seguir.
Opções disponíveis para a propriedade DataType
OPÇÃO DESCRIÇÃO
0 - _Undefined Valor unidimensional não definido (vazio, padrão)

1 - _Null Valor nulo

2 - _Integer Valor unidimensional inteiro de 16 bits sinalizado

318 Objetos de Servidor

 OPÇÃO DESCRIÇÃO
3 - _Long Valor unidimensional inteiro de 32 bits sinalizado

4 - _Single Valor unidimensional de ponto flutuante de 32 bits

5 - _Double Valor unidimensional de ponto flutuante de 64 bits

6 - _Currency Valor unidimensional monetário com quatro casas

decimais

7 - _Date Valor de data e hora

8 - _String Valor literal (texto)

9 - _Object Valor unidimensional de referência a um objeto

10 - _Error Valor unidimensional de código de erro

11 - _Boolean Valor unidimensional Booleano (Verdadeiro ou Falso)

12 - _Variant Dados de qualquer tipo usados para objetos e outros

valores para os quais o tipo de dados é desconhecido

13 - _UnkObject Valor unidimensional de referência a um objeto

14 - _Decimal Valor unidimensional de ponto flutuante de 96 bits

36 - _Record Valor unidimensional de gravação

16 - _Char Valor unidimensional inteiro de oito bits

17 - _Byte Utilizado para criação de DLLs e para OLE, ocupa um

byte de memória

18 - _Word Valor unidimensional inteiro de 16 bits

19 - _Dword Valor unidimensional inteiro de 32 bits

20 - _LongLong Valor unidimensional inteiro de 64 bits sinalizado

21 - _DDWord Valor unidimensional inteiro de 64 bits

22 - _Integer_ Números sem decimais, cujo intervalo de ocorrência

deve estar entre -32.768 e 32.767, ocupa dois bytes

23 - _Uinteger Número inteiro sem sinal (equivalente a um DWord), que

vai de 0 (zero) a 4294967295 (232 - 1)

8194 - _ArrInteger Array unidimensional de valores inteiros

8195 - _ArrLong Array unidimensional de valores inteiros de 32 bits

sinalizados

8196 - _ArrSingle Array unidimensional de valores de ponto flutuante de 32

bits

8197 - _ArrDouble Array unidimensional de valores de ponto flutuante de 64

bits

8198 - _ArrCurrency Array unidimensional de valores monetários com quatro

casas decimais

8199 - _ArrDate Array unidimensional de valores de data e hora

8200 - _ArrString Array unidimensional de valores literais (texto)

8201 - _ArrObject Array unidimensional de valores de referência a um

objeto

8202 - _ArrError Array unidimensional de valores de código de erro

8203 - _ArrBoolean Array unidimensional de valores Booleanos (Verdadeiro

ou Falso)

Objetos de Servidor 319

 OPÇÃO DESCRIÇÃO
8204 - _ArrVariant Array de dados de qualquer tipo usados para objetos e
outros valores para os quais o tipo de dados é
desconhecido

8205 - _ArrUnkObject Array unidimensional de valores de referência a um

objeto

8206 - _ArrDecimal Array unidimensional de valores de ponto flutuante de 96

bits

8228 - _ArrRecord Array unidimensional de valores record

8208 - _ArrChar Array unidimensional de valores char

8209 - _ArrByte Array unidimensional de bytes, que são valores utilizados

para criação de DLLs e para OLE, ocupa um byte de
memória

8210 - _ArrWord Array unidimensional de valores inteiros de 32 bits

8211 - _ArrDWord Array unidimensional de valores inteiros de 32 bits

8212 - _ArrLongLong Array unidimensional de valores inteiros de 16 bits

8213 - _ArrDDWord Array unidimensional de valores inteiros de 32 bits

sinalizados

8214 - _ArrInteger_ Array unidimensional de valores inteiros de 16 bits

sinalizados

8215 - _ArrUInteger Array unidimensional de números inteiros sem sinal

(equivalente a um DWord), que vai de 0 (zero) a
4294967295 (232 -1)

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 esta propriedade do Bloco de Comunicação OPC
está 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, este
evento não ocorre. Também quando esta propriedade está configurada para Verdadeiro, a cada escrita que seja
enviada para o Servidor OPC é gerado o evento OnTagWrite no objeto Driver de Comunicação OPC que contém o
Bloco de Comunicação OPC. Se a escrita é assíncrona, o evento OnTagWrite é gerado apenas quando o Servidor OPC
enviar a resposta indicando o efetivo sucesso ou não da escrita. Neste caso, este evento é gerado apenas se esta
propriedade está configurada para Verdadeiro 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 OPC ao qual o
Driver de Comunicação OPC se conecta. A definição deste caminho é flexível e depende do Servidor OPC específico.
Normalmente, os Servidores OPC especificam um espaço de ID com itens hierárquicos, do tipo
[Link].Tag1. Esta propriedade 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, também configura a qualidade daquele
dado. Esta propriedade é somente de leitura. O valor padrão desta propriedade é 0 (zero, qualidade ruim).

NOTA
Para mais informações sobre qualidade, consulte o tópico Qualidade no Manual do Usuário do Elipse E3.

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 de Bloco de Comunicação OPC para o Bloco de Comunicação OPC, possibilita-se acessar os valores lidos e
320 Objetos de Servidor
também permite a escrita de valores para um equipamento ou dispositivo. O valor padrão desta propriedade é 0
(zero). O script a seguir contém um exemplo de uso desta propriedade.
Sub BlocoOPC1_OnStartRunning()
Size = 12
End Sub
SyncWrite
Esta propriedade determina o tipo de escrita usada por um Bloco de Comunicação OPC. Se esta propriedade está
configurada para Verdadeiro, a escrita é síncrona, isto é, o Driver de Comunicação OPC espera o resultado da escrita
do Servidor OPC. 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 assíncrono, com esta propriedade desabilitada, a performance da comunicação tende a ser melhor,
porém no modo síncrono, com esta propriedade habilitada, o sucesso da operação de escrita é verificado e
informado.

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 propriedade é somente de leitura. O valor padrão desta propriedade é "00:00:00".

[Link].3.4 Elemento de Bloco de Comunicação OPC

Esta seção contém informações sobre eventos e propriedades do objeto Elemento de Bloco de Comunicação OPC
(OPCElementBlock). Este objeto não possui métodos associados.
Eventos
Esta seção contém informações sobre os eventos do objeto Elemento de Bloco de Comunicação OPC
(OPCElementBlock).
OnRead
OnRead()
Ocorre quando um valor do Elemento de Bloco de Comunicação OPC é recebido pelo Servidor OPC. Utilize este
evento para efetuar alguma operação logo após algum dado ter sido modificado no objeto Elemento de Bloco de
Comunicação OPC, nas propriedades Bit00 até Bit31, Quality, RawValue ou Value.
Propriedades
Esta seção contém informações sobre as propriedades do objeto Elemento de Bloco de Comunicação OPC
(OPCElementBlock).
Bit00 até Bit31
Estas propriedades representam juntas os 32 bits do valor presente na propriedade Value do objeto Elemento de
Bloco de Comunicação OPC, em que Bit00 é o bit menos significativo e Bit31 é o bit mais significativo. Modificar cada
um destes bits implica na igual modificação da propriedade Value do Elemento de Bloco de Comunicação OPC e vice-
versa, mas isto somente ocorre quando a propriedade UseBitFields está configurada para Verdadeiro. O valor
padrão desta propriedade é Falso.
DeviceHigh
Esta propriedade define o valor máximo atingido por um Elemento de Bloco de Comunicação OPC no equipamento
ou no dispositivo. Esta propriedade é utilizada para executar o ajuste de escala do valor proveniente do equipamento
ou 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. O valor padrão desta propriedade é 1000. O script a seguir contém
um exemplo de uso desta propriedade.
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala da
' temperatura de um Elemento
' que varia de 0 a 255 no servidor OPC,
' mas que significa na prática
' de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0

Objetos de Servidor 321

 EUHigh = 100
EULow = 0
End Sub
DeviceLow
Esta propriedade define o valor mínimo atingido por um Elemento de Bloco de Comunicação OPC no equipamento
ou no dispositivo. Esta propriedade é utilizada para executar o ajuste de escala do valor proveniente do equipamento
ou 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. O valor padrão desta propriedade é 0 (zero). O script a seguir
contém um exemplo de uso desta propriedade.
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala da
' temperatura de um Elemento
' que varia de 0 a 255 no servidor OPC,
' mas que significa na prática
' de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EnableScaling
Esta propriedade habilita ou desabilita a escala de valor para o valor enviado e recebido do equipamento ou
dispositivo. Se esta propriedade está configurada para Verdadeiro, todo valor proveniente do equipamento ou
dispositivo sofre ajuste de escala conforme as propriedades DeviceHigh, DeviceLow, EUHigh e EULow antes de ser
atribuído à propriedade Value. Isto também ocorre quando uma escrita é necessária, quando o valor presente na
propriedade Value sofre ajuste de escala, sem com isto alterar a propriedade Value, e posteriormente é enviado
para o equipamento ou dispositivo. Se esta propriedade está configurada para Falso, nenhum ajuste de escala é
efetuado em nenhum dos dois sentidos, escrita e leitura. O valor padrão desta propriedade é Falso. O script a seguir
contém um exemplo de uso desta propriedade.
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala da
' temperatura de um Elemento
' que varia de 0 a 255 no servidor OPC,
' mas que significa na prática
' de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EU
Identifica a unidade de engenharia representada por este valor, como por exemplo graus, metros ou KW/h. O valor
padrão desta propriedade é vazio. O script a seguir contém um exemplo de uso desta propriedade.
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala da
' temperatura de um Elemento
' que varia de 0 a 255 no servidor OPC,
' mas que significa na prática
' de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EUHigh
Define qual o valor 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 é executada a
operação inversa antes de enviar o valor para o Driver. Esta conversão só ocorre quando a propriedade

322 Objetos de Servidor

EnableScaling está configurada para Verdadeiro. O valor padrão desta propriedade é 1000. O script a seguir contém
um exemplo de uso desta propriedade.
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala da
' temperatura de um Elemento
' que varia de 0 a 255 no servidor OPC,
' mas que significa na prática
' de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EULow = 100
EULow = 0
End Sub
EULow
Define qual o valor 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). O script a seguir
contém um exemplo de uso desta propriedade.
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala da
' temperatura de um Elemento
' que varia de 0 a 255 no servidor OPC,
' mas que significa na prática
' de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
Index
Utilize esta propriedade para especificar a posição que um Elemento de Bloco de Comunicação OPC ocupa entre os
Elementos de Bloco de Comunicação OPC configurados pela propriedade Size do objeto Bloco de Comunicação OPC
no qual está inserido. Esta propriedade aceita valores de 0 (zero) até um número menor do que o valor definido em
Size. Por exemplo, configurando um Bloco de Comunicação OPC para ter a propriedade Size igual a 20, o número
máximo válido para esta propriedade é 19 e o mínimo é 0 (zero). Esta propriedade pode ser alterada após iniciada a
comunicação. O valor padrão desta propriedade é 0 (zero), porém ao mapear os Elementos de um Bloco de
Comunicação OPC o Elipse E3 Studio automaticamente configura esta propriedade para um valor de acordo com o
especificado. O script a seguir contém um exemplo de uso desta propriedade.
Sub Elemento1_OnRead()
MsgBox Index
End Sub
Quality
Esta propriedade representa o estado de qualidade do valor contido na propriedade Value. Esta propriedade é
somente de leitura.

NOTA
Para mais informações sobre qualidade, consulte o tópico Qualidade no Manual do Usuário do Elipse E3.

RawValue
Acessa o valor original do Elemento de Bloco de Comunicação OPC anterior à escala, ou seja, independente da
configuração da propriedade EnableScaling. Portanto, se esta propriedade está configurada para Falso, a
propriedade Value e esta propriedade apresentam o mesmo comportamento.
UseBitFields
Se esta propriedade está configurada para Verdadeiro, toda vez que o valor da propriedade Value é modificado,
atualiza os bits referentes às propriedades de Bit00 até Bit31. Da mesma forma, atualiza o valor de Value toda vez
que alguma das propriedades de Bit00 até Bit31 mudar de valor e posteriormente envia para o equipamento ou
dispositivo se a propriedade AllowWrite do Bloco de Comunicação OPC está configurada para Verdadeiro. Caso
contrário, se esta propriedade está configurada para Falso, os bits não sofrem nem acarretam qualquer mudança.

Objetos de Servidor 323

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 de Bloco de Comunicação OPC no vetor do Bloco de Comunicação OPC. O tipo de
dados desta propriedade, tais como número inteiro, ponto flutuante ou texto, depende do Driver de Comunicação
OPC ao qual está associada e da 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 está 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 está configurada para Verdadeiro, pode-se escrever
valores em um equipamento ou dispositivo simplesmente atribuindo um novo valor para esta propriedade.
Esta também é a propriedade padrão do objeto Elemento de Bloco OPC. Portanto, uma referência por valor a um
objeto Elemento de Bloco OPC não necessita obrigatoriamente explicitar esta propriedade para acessar o valor. Caso
esta propriedade não seja atualizada, verifique se a propriedade Index está corretamente configurada, ou seja, o
valor deve ser entre 0 (zero) e o tamanho do Bloco de Comunicação OPC menos um. O script a seguir contém um
exemplo de uso desta propriedade.
Sub Botao1_Click()
' Acessa um elemento e mostra o valor atual
' elm1 é um objeto do tipo Elemento de Bloco OPC
Set obj = Application.GetObject_
("OPCDriver1.Grupo1.BlocoOPC1.elm1")
MsgBox "Valor atual de elm1: " & [Link]
' 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

[Link].4 Tag de Comunicação OPC

Esta seção contém informações sobre eventos, métodos e propriedades do objeto Tag de Comunicação OPC
(OPCTag).

[Link].4.1 Eventos
Esta seção contém informações sobre os eventos do objeto Tag de Comunicação OPC (OPCTag).
OnRead
OnRead()
Ocorre quando um valor do Tag de Comunicação OPC é recebido do Servidor OPC. Utilize este evento quando for
necessário efetuar alguma operação logo após algum dado ter sido modificado no objeto Tag de Comunicação OPC,
nas propriedades Bit00 até Bit31, Quality, RawValue, TimeStamp ou Value.

[Link].4.2 Métodos
Esta seção contém informações sobre os métodos do objeto Tag de Comunicação OPC (OPCTag).
Write
Write()
Executa a escrita do valor corrente do Tag de Comunicação OPC no equipamento. Para mais detalhes, consulte a
documentação do Driver. Este método retorna um Booleano que indica o sucesso ou não da operação.
WriteEx
WriteEx([Value], [SyncWrite])
Executa a escrita de um valor em um equipamento. Todos os parâmetros são opcionais. Se omitidos, o
comportamento deste método é igual ao do método Write. Este método retorna um Booleano que indica o sucesso
ou não da operação. O parâmetro Value define o valor a ser escrito no Driver. O tipo de dados depende do Driver. Se
omitido, assume o valor corrente do Tag de Comunicação OPC. O parâmetro SyncWrite é um Booleano que especifica
se a operação descrita deve ser síncrona (Verdadeiro) ou assíncrona (Falso). Se omitido, usa o valor especificado na
propriedade SyncWrite do Tag de Comunicação OPC.

324 Objetos de Servidor

NOTA
Assim como no método Write, a escrita é realizada independente de o valor ser diferente do valor atual do Tag de
Comunicação OPC, bem como independente da propriedade AllowWrite do Tag de Comunicação OPC estar
configurada para Verdadeiro ou Falso. Além disto, se a escrita funciona mas o Tag de Comunicação OPC não está
em scan, seja porque a propriedade AllowRead está configurada para Falso ou porque usa a opção
AdviseWhenLinked quando não está sendo associado, o valor escrito é assumido imediatamente com qualidade
boa e estampa de tempo do momento da escrita.

[Link].4.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Tag de Comunicação OPC (OPCTag).
AdviseType
Controla o modo Advise. As opções disponíveis estão descritas na tabela a seguir.
Opções disponíveis para a propriedade AdviseType
OPÇÃO DESCRIÇÃO
0 - AlwaysInAdvise O Tag de Comunicação OPC é mantido atualizado se a
propriedade AllowRead está configurada para
Verdadeiro e a propriedade Enable do Grupo OPC
também está configurada para Verdadeiro

1 - AdviseWhenLinked O Tag de Comunicação OPC só é atualizado se a

propriedade AllowRead e a propriedade Enable do
Grupo OPC estão configuradas para Verdadeiro, e o Tag
de Comunicação OPC está associado a algum objeto
ativo, como por exemplo um Display de uma Tela aberta
ou um Alarme habilitado, entre outros. A associação do
Tag de Comunicação OPC para este propósito pode ser
realizada nas propriedades Value, RawValue,
TimeStamp, Quality e de Bit00 até Bit31 de Tags de
Comunicação OPC (padrão)

O script a seguir contém um exemplo de uso desta propriedade.

Sub CommandButton3_Click()
MsgBox Application._
GetObject("[Link].TagOPC1").AdviseType
End Sub
AllowRead
Define se este Tag de Comunicação OPC deve ou não ser lido pelo Driver de Comunicação OPC. Caso esta
propriedade esteja configurada para Verdadeiro, o Driver de Comunicação OPC automaticamente atualiza as
propriedades Value, de Bit00 até Bit31, e RawValue deste objeto em intervalos de tempo. Caso contrário, este Tag
de Comunicação OPC não é lido. O valor padrão desta propriedade é Verdadeiro. O script a seguir contém um
exemplo de uso desta propriedade.
Sub Botao1_Click()
' Faz com que seja parada a leitura do tag
Set obj = [Link]("[Link]")
[Link] = False
End Sub
AllowWrite
Define se este Tag de Comunicação OPC deve ou não ser escrito automaticamente quando as propriedades Value,
qualquer uma das propriedades de Bit00 até Bit31, ou RawValue são modificadas. Se esta propriedade está
configurada para Verdadeiro, as modificações são enviadas para o equipamento ou dispositivo associado ao Driver
de Comunicação OPC. Do contrário, as modificações são ignoradas. O valor padrão desta propriedade é Verdadeiro.
O script a seguir contém um exemplo de uso desta propriedade.
Sub Botao1_Click()
' Faz com que seja desabilitada a escrita do tag
Set obj = [Link]("[Link]")
[Link] = False
End Sub

Objetos de Servidor 325

Bit00 até Bit31
Estas propriedades representam juntas os 32 bits do valor presente na propriedade Value do objeto Tag de
Comunicação OPC, em que Bit00 é o bit menos significativo e Bit31 é o bit mais significativo. Modificar cada um
destes bits implica na igual modificação da propriedade Value do Tag de Comunicação OPC e vice-versa, mas isto
somente ocorre quando a propriedade UseBitFields está configurada para Verdadeiro. O valor padrão desta
propriedade é Falso.
DataType
Determina o tipo de dados associado ao Tag de Comunicação OPC. Esta propriedade é somente de leitura.
Consulte 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 em um equipamento ou
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 os valores permanecem os mesmos. O valor padrão desta
propriedade é 1000. O script a seguir contém um exemplo de uso desta propriedade.
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 valores dos bits, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é, representam
os bits do valor lido de um equipamento antes da conversão.

DeviceLow
Esta propriedade define o valor mínimo atingido por um Tag de Comunicação OPC em um equipamento ou
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). O script a seguir contém um exemplo de uso desta propriedade.
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 valores dos bits, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é, representam
os bits do valor lido de um equipamento antes da conversão.

EnableDriverEvent
Esta propriedade é utilizada para controlar a geração do evento OnTagRead, que ocorre no Driver de
Comunicação OPC que contém o Tag de Comunicação OPC. Se esta propriedade do Tag de Comunicação OPC está
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 Tag de Comunicação OPC. Caso contrário, o
evento não ocorre. Também quando esta propriedade está configurada para Verdadeiro, a cada escrita que seja

326 Objetos de Servidor

enviada para o Servidor OPC é gerado o evento OnTagWrite no objeto Driver de Comunicação OPC que contém o
Tag de Comunicação OPC. Se a escrita é assíncrona, o evento OnTagWrite é gerado apenas quando o Servidor OPC
enviar a resposta indicando o efetivo sucesso ou não da escrita. Neste caso, o evento é gerado apenas se esta
propriedade está configurada para Verdadeira neste momento, e não no momento do envio da escrita. O valor
padrão desta propriedade é Falso.
EnableScaling
Se esta propriedade está configurada para Verdadeiro, todo valor proveniente do equipamento ou do dispositivo
sofre ajuste de escala conforme as propriedades EUHigh e EULow antes de ser atribuído à propriedade Value. Caso
esta propriedade esteja configurada para Falso, nenhum ajuste de escala é efetuado em nenhum dos dois sentidos,
tanto para escrita como para leitura. O valor padrão desta propriedade é Falso. O script a seguir contém um exemplo
de uso desta propriedade.
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
EU
Identifica a unidade de engenharia representada pelo valor, como por exemplo graus, metros ou KW/h. O valor
padrão desta propriedade é vazio. O script a seguir contém um exemplo de uso desta propriedade.
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
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 é 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 é 1000. O script a seguir contém
um exemplo de uso desta propriedade.
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 valores dos bits, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é, representam
os bits do valor lido de um equipamento antes 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). O script a seguir
contém um exemplo de uso desta propriedade.

Objetos de Servidor 327

 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 valores dos bits, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é, representam
os bits do valor lido de um equipamento antes da conversão.

ItemID
Esta propriedade determina o caminho que identifica o Tag de Comunicação OPC no Servidor OPC ao qual o Driver
de Comunicação OPC se conecta. A definição deste caminho é flexível e depende do Servidor OPC específico.
Normalmente os Servidores OPC especificam um espaço de ID com itens hierárquicos, do tipo
[Link].Tag1. Esta propriedade funciona como uma chave única para os dados, considerando o onde ou o
quê permite o Servidor OPC se conectar à fonte dos dados. Apesar de o valor padrão ser vazio, é necessário
especificar algum valor para que o Tag 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 Tag de Comunicação OPC, também configura a qualidade daquele
dado. Esta propriedade é somente de leitura. O valor padrão desta propriedade é 0 (zero, qualidade ruim).

NOTA
Para mais informações sobre qualidade, consulte o tópico Qualidade no Manual do Usuário do Elipse E3.

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 está configurada para Falso, a propriedade Value e esta
propriedade apresentam o mesmo comportamento.
SyncWrite
Esta propriedade determina o tipo de escrita usada por um Tag de Comunicação OPC. Se a propriedade está
configurada para Verdadeiro, a escrita é síncrona, isto é, o Driver de Comunicação OPC espera o resultado da escrita
do Servidor OPC. 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 assíncrono, esta propriedade configurada para Falso, a performance da comunicação tende a ser melhor,
porém no modo síncrono, esta propriedade configurada para Verdadeiro, o sucesso da operação de escrita é
verificado e informado.

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 propriedade é somente de leitura. O valor padrão desta propriedade é "00:00:00".
UseBitFields
Caso esta propriedade esteja configurada para Verdadeiro, toda vez que o valor da propriedade Value é
modificado, atualiza os bits referentes às propriedades de Bit00 até Bit31. Da mesma forma, atualiza o valor de
Value toda vez que alguma das propriedades de Bit00 até Bit31 mudar de valor e posteriormente envia para o
equipamento ou dispositivo se a propriedade AllowWrite está configurada para Verdadeiro. Caso contrário, se esta
propriedade está configurada para Falso, os bits não sofrem qualquer mudança. Esta propriedade pode sofrer
atualização após ter sido iniciada a comunicação. O valor padrão desta propriedade é Falso. O script a seguir contém
um exemplo de uso desta propriedade.

328 Objetos de Servidor

 Sub TagOPC1_Click()
UseBitFields = True
End Sub

NOTA
Os valores dos bits, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é, representam
os bits do valor lido de um equipamento antes da conversão.

Value
Esta propriedade é atualizada quando é executada uma nova leitura válida de um valor do equipamento ou do
dispositivo utilizando a configuração, porém o tipo de dados desta variável, tais como número inteiro, ponto flutuante
ou texto, depende do Driver de Comunicação OPC ao qual está associado e da configuração. Esta propriedade
somente é atualizada desta forma se a propriedade AllowRead está configurada para Verdadeiro e quando não
houver erros de comunicação, e 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 esta propriedade ou alguma das propriedades de 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 esta propriedade para acessar o valor. O valor padrão desta propriedade é vazio. O script a seguir contém
um exemplo de uso desta propriedade.
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: " & [Link]
' Sem mostrar a propriedade Value, que é padrão
MsgBox "Valor atual de tag1: " & obj
End Sub

5.5.3 Driver de Comunicação OPC UA

Esta seção contém informações sobre eventos, métodos e propriedades do objeto Driver de Comunicação OPC UA
(UaDriver).

[Link] Eventos
Esta seção contém informações sobre os eventos do objeto Driver de Comunicação OPC UA (UaDriver).

[Link].1 OnTagRead
OnTagRead(Tag)
Ocorre na leitura de um Tag de Comunicação OPC UA, sempre que um novo valor ou erro é retornado pelo Servidor
OPC UA, ou seja, se o valor ou a qualidade do Tag de Comunicação OPC UA não mudarem, este evento não é
disparado. Para que este evento ocorra, a propriedade EnableDriverEvent do Tag de Comunicação OPC UA deve
obrigatoriamente estar habilitada.

[Link].2 OnTagWrite
OnTagWrite(Tag, Succeeded, User)
Ocorre quando uma escrita é disparada em qualquer Tag de Comunicação OPC UA do Driver de Comunicação OPC
UA. Para que este evento ocorra, a propriedade EnableDriverEvent do Tag de Comunicação OPC UA deve
obrigatoriamente estar habilitada. Se a escrita é assíncrona, este evento é gerado apenas quando o Servidor OPC UA
enviar a resposta indicando o efetivo sucesso ou não da escrita.
Parâmetros do evento OnTagWrite
PARÂMETRO DESCRIÇÃO
Tag Uma referência para o objeto Tag de Comunicação OPC
UA que sofre a escrita. Por exemplo, pode-se acessar a
propriedade do Tag de Comunicação OPC UA usando a
sintaxe [Link]

Succeeded Um valor Booleano que indica sucesso ou falha na escrita

Objetos de Servidor 329

 PARÂMETRO DESCRIÇÃO
User Parâmetro que recebe o usuário que executou a escrita.
O valor padrão deste parâmetro é "System". Se não
houver nenhum usuário logado no Elipse E3 Viewer que
gerou este evento, este parâmetro contém o valor
"Anonymous". Se a escrita é assíncrona ou se ocorreu
uma falha reportada de forma assíncrona, este
parâmetro sempre contém o valor "System"

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Driver de Comunicação OPC UA (UaDriver).

[Link].1 RefreshUaNodeIds
RefreshUaNodeIds()
Atualiza todos os Blocos de Comunicação OPC UA e Tags de Comunicação OPC UA de um Driver de Comunicação
OPC UA, buscando os Identificadores de Nós OPC UA (NodeIds) no Servidor OPC UA e atualizando as propriedades
UaNodeId dos Blocos de Comunicação OPC UA e dos Tags de Comunicação OPC UA. Este método retorna um
Booleano indicando o sucesso ou não da operação.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Driver de Comunicação OPC UA (UaDriver).

[Link].1 EndPointURL
Propriedade de leitura e escrita que especifica o caminho, ou ponto de conexão, do Servidor OPC UA ao qual o
Cliente OPC UA se conecta. Esta propriedade não pode ser alterada com a comunicação ativa.

[Link].2 MaxNodesPerClientCall
Esta propriedade gerencia o tamanho máximo do array de nós passados por padrão nas requisições síncronas a
um Servidor OPC UA. O valor padrão desta propriedade é 0 (zero), que desabilita este gerenciamento. O uso desta
propriedade permite que uma requisição seja dividida em requisições menores, evitando erros do tipo
BadTooManyOperations. Os serviços OPC UA afetados ao definir um valor nesta propriedade são
SyncReadAttributes, MapNodeIds, CreateMonitoredItems e DeleteMonitoredItems.

NOTA
A definição de um valor para esta propriedade depende dos limites operacionais definidos pelas propriedades
MaxNodesPerTranslateBrowsePathsToNodeIds, MaxMonitoredItemsPerCall, MaxNodesPerHistoryReadData e
MaxNodesPerRead de um Servidor OPC UA. Consulte a documentação específica do Servidor OPC UA para mais
informações sobre estes limites operacionais.

[Link].3 OverrideEndpointURLHost
Esta propriedade força a utilização do ponto de conexão ou endpoint usado para conectar a um Servidor OPC UA,
configurado na propriedade EndPointURL, nos casos em que um Servidor OPC UA retorne uma lista de pontos de
conexão que podem ou não estar acessíveis ao Cliente OPC UA. O valor padrão desta propriedade é Falso.

[Link].4 Password
Propriedade de leitura e escrita que especifica a senha do usuário que é usado na conexão com um Servidor OPC
UA. Esta propriedade é usada em conjunto com a propriedade UserName. O valor padrão desta propriedade é uma
String vazia.

NOTA
Esta propriedade pode ser alterada com a comunicação ativa, mas esta alteração só tem efeito quando o Cliente
OPC UA é reiniciado.

330 Objetos de Servidor

[Link].5 PublishLimit
Configura o limite de requisições de publicação (publish requests) de um Driver de Comunicação OPC UA, de forma a
evitar uma sobrecarga de requisições em Servidores OPC UA. O valor padrão desta propriedade é 5 (cinco).

NOTAS
· Para aplicações criadas em versões anteriores à versão 6.7 e abertas em versões a partir da versão 6.7, o valor
padrão desta propriedade é 0 (zero).
· Configurar esta propriedade com o valor 0 (zero) mantém o comportamento anterior de não impor um limite de
requisições de publicação no lado do Cliente OPC UA.

[Link].6 SecurityMode
Propriedade de leitura e escrita que especifica o modo de segurança que é usado na conexão com um Servidor
OPC UA. Esta propriedade não pode ser alterada com a comunicação ativa. Os valores possíveis para esta
propriedade são 1 - usmNone: Não utiliza nenhum modo de segurança na conexão (padrão), 2 - usmSign: Utiliza
autenticação na conexão ou 3 - usmSignAndEncrypt: Utiliza autenticação e criptografia na conexão. Esta propriedade
é usada em conjunto com a propriedade SecurityPolicy para determinar o tipo de segurança da conexão.

NOTA
Se esta propriedade é diferente de usmNone, é necessário que o Servidor OPC UA aceite o certificado da instância
do Cliente Elipse E3. A forma como um certificado é aceito ou reconhecido por um Servidor OPC UA depende do
Servidor OPC UA.

[Link].7 SecurityPolicy
Propriedade de leitura e escrita que especifica a política de segurança ou criptografia usada na conexão com um
Servidor OPC UA. Esta propriedade não pode ser alterada com a comunicação ativa. Os valores possíveis para esta
propriedade são 1 - uspNone: Não utiliza criptografia na conexão (padrão), 2 - uspBasic128Rsa15: Utiliza o algoritmo
RSA com chave de 128 bits na conexão, 3 - uspBasic256: Utiliza o algoritmo AES com chave de 256 bits na conexão, 4
- uspBasic256Sha256: Utiliza o algoritmo SHA com chave de 256 bits na conexão, 5 - uspAes128_Sha256_RsaOaep:
Utiliza o algoritmo SHA com chave de 256 bits combinado com o algoritmo RSA e o método OAEP (Optimal
Asymmetric Encryption Padding) na conexão ou 6 - uspAes256_Sha256_RsaPss: Utiliza o algoritmo SHA com chave de
256 bits combinado com o algoritmo RSA e o método PSS (Probabilistic Signature Scheme) na conexão. Esta
propriedade é usada em conjunto com a propriedade SecurityMode para determinar o tipo de segurança da
conexão.

[Link].8 ServerState
Retorna o estado da conexão ou de um Servidor OPC UA. Esta propriedade é somente de leitura. Os valores
possíveis para esta propriedade são -1 - ussNotConnected: O Servidor OPC UA não está conectado (padrão), 0 -
ussRunning: O Servidor OPC UA está executando normalmente, 1 - ussFailed: O Servidor OPC UA não está
executando, 2 - ussNoConfig: O Servidor OPC UA está executando, mas sem informações de configuração, 3 -
ussSuspended: O Servidor OPC UA foi suspenso temporariamente, 4 - ussShutdown: O Servidor OPC UA foi
desligado, 5 - ussTest: O Servidor OPC UA está em modo de teste, 6 - ussCommunicationFault: Houve uma falha na
comunicação com o Servidor OPC UA ou 7 - ussUnknown: O estado do Servidor OPC UA é desconhecido.

[Link].9 TimeoutCall
Propriedade de leitura e escrita que especifica o tempo limite de uma chamada a um Servidor OPC UA, em
milissegundos. Esta propriedade não pode ser alterada com a comunicação ativa e o valor deve ser maior que 0
(zero). O valor padrão desta propriedade é 10000 (10 segundos).

NOTA
No padrão OPC UA, várias chamadas permitem continuar a comunicação, com múltiplas respostas do Servidor OPC
UA. Desta forma, este tempo acaba por ser o tempo limite de resposta de um Servidor OPC UA.

Objetos de Servidor 331

[Link].10 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 o valor deve ser maior que 0 (zero). Esta propriedade não pode ser alterada
com a comunicação ativa.

[Link].11 TimeoutSession
Propriedade de leitura e escrita que especifica o tempo limite para a renovação da sessão de comunicação do
Cliente Elipse E3 com um 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.

[Link].12 UserName
Propriedade de leitura e escrita que especifica o nome do usuário usado na conexão com um Servidor OPC UA. Esta
propriedade é usada em conjunto com a propriedade Password. O valor padrão desta propriedade é uma String
vazia.

NOTA
Esta propriedade pode ser alterada com a comunicação ativa, mas esta alteração só tem efeito quando o Cliente
OPC UA é reiniciado.

[Link].13 WriteFeedbackMode
Esta propriedade permite controlar a confirmação ou feedback das escritas em Tags de Comunicação OPC UA. As
opções de configuraçã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 escrita, aguarda normalmente a próxima leitura

1 - wfImmediateReadAfterWrite Força uma leitura assíncrona de dispositivo logo após

cada escrita (padrão)

2 - wfTrustWriteSuccess O valor escrito é assumido pelo Tag de Comunicação

OPC UA imediatamente, caso a escrita tenha funcionado

NOTAS
· Esta propriedade não pode ser alterada com o objeto ativo.
· Na opção 2 - wfTrustWriteSuccess, no caso de escritas assíncronas, o valor é assumido no Tag de Comunicação
OPC UA após o agendamento da escrita, se a operação é bem sucedida. Porém, se a escrita falhar
posteriormente, o valor no Tag de Comunicação OPC UA pode estar errado. No caso da escrita síncrona, o valor é
assumido logo após o término da escrita, se houver sucesso.

[Link].14 WriteValueMode
Propriedade de leitura e escrita que controla o comportamento do envio do valor nas operações de escrita. Esta
propriedade deve ser configurada de acordo com o Servidor OPC UA utilizado, pois do contrário a escrita falha. Os
valores possíveis para esta propriedade são 0 - wvmDefault: Segue o comportamento padrão do Driver de
Comunicação OPC UA de escrever apenas o valor, 1 - wvmValueOnly: Escreve apenas o valor (padrão) ou 2 -
wvmValueQualityTimestamp: Envia sempre a qualidade e a estampa de tempo junto com o valor. Esta propriedade
não pode ser alterada com a comunicação ativa.

NOTA
Utilizar o valor 2 - wvmValueQualityTimestamp afeta a forma como os valores são enviados para um Servidor OPC
UA, independente da forma como a escrita é disparada pelo Elipse E3.

[Link] Assinatura OPC UA

Esta seção contém informações sobre as propriedades do objeto Assinatura OPC UA (UaSubscription). Este objeto
não possui eventos nem métodos associados.

332 Objetos de Servidor

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Assinatura OPC UA (UaSubscription).

[Link].1.1 Enable
Esta propriedade habilita a atualização dos Tags de Comunicação OPC UA dentro de uma Assinatura OPC UA. Se
esta propriedade está configurada para Falso, nenhum Tag de Comunicação OPC UA dentro da Assinatura OPC UA é
atualizado. Caso contrário, os Tags de Comunicação OPC UA que tenham a propriedade AllowRead configurada para
Verdadeiro e que estejam em modo Advise são mantidos atualizados de acordo com o tempo de atualização,
definido na propriedade Scan. Para mais informações, consulte a propriedade AdviseType. Se esta propriedade está
configurada para Falso, não é possível utilizar o método RefreshUaNodeIds do Driver de Comunicação OPC UA.

[Link].1.2 RealScan
Tempo de varredura efetivamente utilizado por um Servidor OPC UA. Esta propriedade é somente de leitura.

[Link].1.3 Scan
Especifica o tempo de varredura de atualização dos Tags de Comunicação OPC UA da Assinatura OPC UA que é
utilizado pelo Servidor OPC UA. Esta propriedade é representada em milissegundos e pode ser modificada após
iniciada a comunicação. Esta propriedade é utilizada apenas quando a propriedade Enable está configurada para
Verdadeiro. Ao configurar esta propriedade nos diversos Tags de Comunicação OPC UA presentes em uma aplicação,
recomenda-se aumentar o valor desta propriedade para aquelas Assinaturas OPC UA de Tags de Comunicação OPC
UA que não variam muito no equipamento ou dispositivo, possibilitando assim que outras Assinaturas OPC UA de
Tags de Comunicação OPC UA de maior prioridade sejam lidas com maior frequência, aumentando assim a
performance e a resposta de uma aplicação. O valor padrão desta propriedade é 1000.

[Link].2 Bloco de Comunicação OPC UA

Esta seção contém informações sobre eventos, métodos e propriedades do objeto Bloco de Comunicação OPC UA
(UaTagBlock).

[Link].2.1 Eventos
Esta seção contém informações sobre os eventos do objeto Bloco de Comunicação OPC UA (UaTagBlock).
OnRead
OnRead()
Ocorre quando um valor do Bloco de Comunicação OPC UA é recebido de um Servidor OPC UA. Utilize este evento
para efetuar alguma operação logo após algum dado ter sido modificado no objeto Bloco de Comunicação OPC UA,
nas propriedades Bit00 até Bit31, Quality, RawValue, TimeStamp e Value de algum Elemento do Bloco de
Comunicação OPC UA.

[Link].2.2 Métodos
Esta seção contém informações sobre os métodos do objeto Bloco de Comunicação OPC UA (UaTagBlock).
Write
Write()
Executa a escrita do valor corrente do Bloco de Comunicação OPC UA no equipamento. Para mais detalhes, consulte a
documentação do Driver. Este método retorna um Booleano que indica o sucesso ou não da operação.
WriteEx
WriteEx([Value], [NewTimestamp], [NewQuality], [SyncWrite])
Executa a escrita de um valor no equipamento. Todos os parâmetros são opcionais. Se omitidos, o comportamento
do método é igual ao do método Write. Este método retorna um Booleano que indica o sucesso ou não da
operação. O parâmetro Value define o valor a ser escrito no Driver de Comunicação OPC UA. O tipo de dados
depende do Driver. Se omitido, assume o valor corrente do Bloco de Comunicação OPC UA. Se especificado, deve ser
um array com o mesmo número de Elementos do Bloco de Comunicação OPC UA. Os parâmetros NewTimestamp e
NewQuality indicam, respectivamente, a estampa de tempo e a qualidade do valor, caso a propriedade
WriteValueMode esteja configurada para 2 - wvmValueQualityTimestamp. O parâmetro SyncWrite é um Booleano
que especifica se a operação descrita deve ser síncrona (Verdadeiro) ou assíncrona (Falso). Se omitido, usa o valor
especificado na propriedade SyncWrite do Bloco de Comunicação OPC UA.

Objetos de Servidor 333

NOTA
Assim como no método Write, a escrita é realizada independente de o valor ser diferente do valor atual do Bloco de
Comunicação OPC UA, bem como independente da propriedade AllowWrite do Bloco de Comunicação OPC UA
estar configurada como Verdadeiro ou Falso. Além disto, se a escrita funciona mas o Bloco de Comunicação OPC UA
não está em scan, seja porque a propriedade AllowRead está configurada como Falso ou porque usa a opção
AdviseWhenLinked quando não está associado, o valor escrito é assumido imediatamente com qualidade boa e
estampa de tempo do momento da escrita.

[Link].2.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Bloco de Comunicação OPC UA (UaTagBlock).
AdviseType
Controla o modo Advise. As opções disponíveis estão descritas na tabela a seguir.
Opções disponíveis para a propriedade AdviseType
OPÇÃO DESCRIÇÃO
0 - AlwaysInAdvise O Bloco de Comunicação OPC UA é mantido atualizado
se a propriedade AllowRead do Bloco de Comunicação
OPC UA está configurada como Verdadeiro e a
propriedade Enable da Assinatura OPC UA também está
configurada como Verdadeiro

1 - AdviseWhenLinked O Bloco de Comunicação OPC UA só é atualizado se a

propriedade AllowRead do Bloco de Comunicação OPC
UA e a propriedade Enable da Assinatura OPC UA estão
configuradas como Verdadeiro, e o Bloco de
Comunicação OPC UA está associado a algum objeto
ativo, como por exemplo um Display de uma Tela aberta
ou um Alarme habilitado, entre outros. A associação do
Bloco de Comunicação OPC UA para este propósito
pode ser realizada nas propriedades Value, RawValue,
Quality e de Bit00 até Bit31 de Elementos de Bloco de
Comunicação OPC UA, e Quality e TimeStamp de Blocos
de Comunicação OPC UA (padrão)

AllowRead
Configure esta propriedade para definir se este Bloco de Comunicação OPC UA deve ou não ser lido pelo Driver de
Comunicação OPC UA. Se esta propriedade está configurada para Verdadeiro, então o Driver de Comunicação OPC
UA automaticamente atualiza as propriedades Value e de Bit00 até Bit31, dos Elementos de Bloco de Comunicação
OPC UA do Bloco de Comunicação OPC UA em intervalos de tempo. Caso contrário, este Bloco de Comunicação OPC
UA não é lido se esta propriedade está configurada para Falso. O valor padrão desta propriedade é Verdadeiro.
AllowWrite
Configure esta propriedade para definir se este Bloco de Comunicação OPC UA deve ou não ser escrito
automaticamente quando a propriedade Value ou qualquer das propriedades de Bit00 até Bit31, é modificada. Se
esta propriedade está configurada para Verdadeiro, as modificações são enviadas para o equipamento ou dispositivo
associado ao Driver de Comunicação OPC UA, do contrário as modificações são ignoradas. Estando esta propriedade
configurada para Verdadeiro, então o Driver de Comunicação OPC UA automaticamente atualiza as propriedades
Value e de Bit00 até Bit31, deste objeto, em intervalos de tempo. Caso contrário, este Bloco de Comunicação OPC UA
não é lido. O valor padrão desta propriedade é Verdadeiro.
DataType
Propriedade preenchida quando o Elipse E3 se conecta a um Servidor OPC UA, que indica o tipo de dados neste
Servidor OPC UA. Esta propriedade é inicialmente preenchida no processo de busca (browsing), se realizado, e em
cada comunicação ou conexão com um Servidor OPC UA. Valores abaixo de 1000 são escalares e valores acima de
1000 são vetores (arrays). Esta propriedade é somente de leitura. Os valores possíveis para esta propriedade estão
descritos na tabela a seguir.

334 Objetos de Servidor

 Valores possíveis para a propriedade DataType
VALOR DESCRIÇÃO
17 udtNodeId (Identificador de Nó OPC UA, formatado
como um vetor de três elementos no Elipse E3)

18 udtExpandedNodeId (Identificador de Nó OPC UA

expandido, formatado como um vetor de três elementos
no Elipse E3)

22 udtStructure (Indica que é um tipo de dados complexo

do OPC UA, mas não específico, formatado como um
vetor onde cada elemento é um membro da estrutura)

25 udtDiagnosticInfo

1000 udtArrayUnknown (Vetor genérico, de tipos de dados

não conhecidos)

1001 udtArrayBoolean

1002 udtArraySByte

1003 udtArrayByte

1004 udtArrayInt16

1005 udtArrayUInt16

1006 udtArrayInt32

1007 udtArrayUInt32

1008 udtArrayInt64

1009 udtArrayUInt64

1010 udtArrayFloat

1011 udtArrayDouble

1012 udtArrayString

1013 udtArrayDateTime

1014 udtArrayGuid

1015 udtArrayByteString

1016 udtArrayXmlElement

1017 udtArrayNodeId

1018 udtArrayExpandedNodeId

1019 udtArrayStatusCode

1020 udtArrayQualifiedName

1021 udtArrayLocalizedText

1022 udtArrayStructure

1023 udtArrayDataValue

1024 udtArrayVariant

Objetos de Servidor 335

NOTAS
· Estruturas definidas por Servidores OPC UA específicos, não compatíveis com o padrão OPC UA, não são lidas
pelo Elipse E3.
· Os tipos de dados udtArrayQualifiedName, udtArrayLocalizedText, udtStructure, udtArrayStructure,
udtArrayDataValue e udtArrayUnknown não permitem a escrita na versão atual do Elipse E3, pois o Elipse E3
utiliza uma formatação simplificada destes tipos de dados.
· Os tipos de dados ServiceCounterDataType (array de duas posições), BuildIndfo (array de seis posições),
Argument (array de seis posições), ApplicationDescription (array de oito posições),
SessionDiagnosticsDataType (array de 44 posições), SessionSecurityDiagnosticsDataType (array de 10
posições), SubscriptionsDiagnosticsDataType (array de 31 posições), ServerDiagnosticsSummaryDataType
(array de 12 posições), ServerStatusDataType (array de seis posições), EuInformation (array de quatro posições),
Range (array de duas posições), TimeZoneDataType (array de duas posições), DiagnosticInfo (array de sete
posições), StatusResult (array de duas posições), ComplexNumberType (array de duas posições),
DoubleComplexNumberType (array de duas posições), XVType (array de duas posições),
RedundanteServerSataType (array de três posições), SamplingIntervalDiagnosticsDataType (array de quatro
posições), EnumValueType (array de três posições), EndpointUrlListDataType (array de duas posições) e
NetworkGroupDataType (array de três posições) são mostrados como udtStructure, mas o Elipse E3 trata o tipo
de dados específico.
· Na versão atual, o Elipse E3 só permite vetores de uma dimensão, ou seja, não permite matrizes como tipos de
dados.

EnableDriverEvent
Esta propriedade é utilizada para controlar a geração do evento OnTagRead, que ocorre no Driver de
Comunicação OPC UA que contém o Bloco de Comunicação OPC UA. Se esta propriedade está configurada para
Verdadeiro, a cada leitura vinda do Servidor OPC UA, seja com erro ou não, é gerado o evento OnTagRead no objeto
Driver de Comunicação OPC UA que contém este Bloco de Comunicação OPC UA. Caso contrário, o evento não ocorre.
Também quando esta propriedade está configurada para Verdadeiro, a cada escrita que seja enviada para o Servidor
OPC UA é gerado o evento OnTagWrite no objeto Driver de Comunicação OPC UA que contém o Bloco de
Comunicação OPC UA. Se a escrita é assíncrona, o evento OnTagWrite é gerado apenas quando o Servidor OPC UA
enviar a resposta indicando o efetivo sucesso ou não da escrita. Neste caso, o evento é gerado apenas se esta
propriedade está configurada como Verdadeiro neste momento, e não no momento do envio da escrita. O valor
padrão desta propriedade é Falso.
ItemID
Especifica o caminho para realizar a busca, ou browsing, de um Bloco de Comunicação OPC UA em um Servidor OPC
UA. Este caminho é usado no método RefreshUaNodeIds do Driver de Comunicação OPC UA para recuperar o
Identificador de Nó OPC UA de um Bloco de Comunicação OPC UA, quando desejado.
Quality
Esta propriedade informa qual a qualidade do valor contido na propriedade Value. Cada vez que o Driver de
Comunicação OPC UA atribui um novo valor para o Bloco de Comunicação OPC UA, também configura a qualidade
daquele dado. Esta propriedade é somente de leitura. O valor padrão desta propriedade é 0 (zero, qualidade ruim).

NOTA
Para mais informações sobre qualidade, consulte o tópico Qualidade no Manual do Usuário do Elipse E3.

Size
Define o tamanho do conjunto de valores do Bloco de Comunicação OPC UA. Consulte a documentação do Driver
utilizado para saber qual o limite para esta propriedade, de acordo com os parâmetros B1 até B4. Criando os
Elementos de Bloco de Comunicação OPC UA para o Bloco de Comunicação OPC UA, possibilita-se acessar os valores
lidos e também permite a escrita de valores para o equipamento ou dispositivo. O valor padrão desta propriedade é
0 (zero).
SyncWrite
Esta propriedade determina o tipo de escrita usada por um Bloco de Comunicação OPC UA. Se esta propriedade
está configurada para Verdadeiro, a escrita é síncrona, isto é, o Driver de Comunicação OPC UA espera o resultado da
escrita do Servidor OPC UA. Caso contrário, a escrita é assíncrona, isto é, o valor do Bloco de Comunicação OPC UA é
enviado e o processamento do Driver de Comunicação OPC UA continua imediatamente. O valor padrão desta
propriedade é Falso.

336 Objetos de Servidor

NOTA
No modo assíncrono, com esta propriedade desabilitada, a performance da comunicação tende a ser melhor,
porém no modo síncrono, esta propriedade habilitada, o sucesso da operação de escrita é verificado e informado.

TimeStamp
Esta propriedade é atualizada sempre que ocorre alguma mudança de valor ou de estado nas propriedades Value
ou Quality. Esta propriedade informa qual a data e hora associadas tanto ao valor quanto à qualidade do Bloco de
Comunicação OPC UA. Esta propriedade é somente de leitura. O valor padrão desta propriedade é "00:00:00".
UaNodeId
Especifica o caminho para realizar a busca, ou browsing, de um Bloco de Comunicação OPC UA em um Servidor
OPC UA. Este caminho é usado no método RefreshUaNodeIds do Driver de Comunicação OPC UA para recuperar o
Identificador de Nó OPC UA de um Bloco de Comunicação OPC UA, quando desejado. Esta propriedade deve estar
preenchida para estabelecer a comunicação com um Servidor OPC UA.
WriteValueMode
Propriedade de leitura e escrita que controla o comportamento do envio do valor nas operações de escrita. Esta
propriedade deve ser configurada de acordo com o Servidor OPC UA utilizado, pois do contrário a escrita falha. Os
valores possíveis para esta propriedade são 0 - wvmDefault: Segue o comportamento padrão, isto é, o
comportamento configurado no Driver de Comunicação OPC UA a que este Bloco de Comunicação OPC UA pertence,
1 - wvmValueOnly: Escreve apenas o valor ou 2 - wvmValueQualityTimestamp: Envia sempre a qualidade e a
estampa de tempo junto com o valor.

[Link].2.4 Elemento de Bloco de Comunicação OPC UA

Esta seção contém informações sobre eventos e propriedades do objeto Elemento de Bloco de Comunicação OPC UA
(UaElementBlock). Este objeto não possui métodos associados.
Eventos
Esta seção contém informações sobre os eventos do objeto Elemento de Bloco de Comunicação OPC UA
(UaElementBlock).
OnRead
OnRead()
Ocorre quando um valor do Elemento de Bloco de Comunicação OPC UA é recebido por um Servidor OPC UA. Utilize
este evento para efetuar alguma operação logo após algum dado ter sido modificado no objeto Elemento de Bloco
de Comunicação OPC UA, nas propriedades Bit00 até Bit31, Quality, RawValue ou Value.
Propriedades
Esta seção contém informações sobre as propriedades do objeto Elemento de Bloco de Comunicação OPC UA
(UaElementBlock).
Bit00 até Bit31
Estas propriedades representam juntas os 32 bits do valor presente na propriedade Value do objeto Elemento de
Bloco de Comunicação OPC UA, em que Bit00 é o bit menos significativo e Bit31 é o bit mais significativo. Modificar
cada um destes bits implica em modificar também a propriedade Value do Elemento de Bloco de Comunicação OPC
UA e vice-versa, mas isto somente ocorre quando a propriedade UseBitFields está configurada para Verdadeiro. O
valor padrão desta propriedade é Falso.
DeviceHigh
Esta propriedade define o valor máximo atingido por um Elemento de Bloco de Comunicação OPC UA em um
equipamento ou dispositivo. Esta propriedade é utilizada para executar o ajuste de escala do valor proveniente de um
equipamento ou 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. O valor padrão desta propriedade é 1000.
DeviceLow
Esta propriedade define o valor mínimo atingido por um Elemento de Bloco de Comunicação OPC UA em um
equipamento ou dispositivo. Esta propriedade é utilizada para executar o ajuste de escala do valor proveniente de um
equipamento ou 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. O valor padrão desta propriedade é 0 (zero).

Objetos de Servidor 337

EnableScaling
Esta propriedade habilita ou desabilita a escala de valor para o valor enviado e recebido de um equipamento ou
dispositivo. Se esta propriedade está configurada para Verdadeiro, todo valor proveniente de um equipamento ou
dispositivo sofre ajuste de escala conforme as propriedades DeviceHigh, DeviceLow, EUHigh e EULow antes de ser
atribuído à propriedade Value. O mesmo ocorre quando uma escrita é necessária, quando o valor presente na
propriedade Value sofre ajuste de escala, sem com isto alterar a propriedade Value, e posteriormente é enviado
para um equipamento ou dispositivo. Caso esta propriedade esteja configurada para Falso, nenhum ajuste de escala é
efetuado em nenhum dos dois sentidos, escrita e leitura. O valor padrão desta propriedade é Falso.
EU
Identifica a unidade de engenharia representada por este valor, como por exemplo graus, metros ou KW/h. O valor
padrão desta propriedade é vazio.
EUHigh
Define qual o valor máximo que deve ser atribuído à propriedade Value, ajustando a escala ao valor de um
equipamento ou 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 é 1000.
EULow
Define qual o valor mínimo que deve ser atribuído à propriedade Value, ajustando a escala ao valor de um
equipamento ou 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).
Index
Utilize esta propriedade para especificar a posição que um Elemento de Bloco de Comunicação OPC UA ocupa entre
os Elementos de Bloco de Comunicação OPC UA configurados pela propriedade Size do objeto Bloco de
Comunicação OPC UA no qual está inserido. Esta propriedade aceita valores de 0 (zero) até um número menor do que
o valor definido em Size. Por exemplo, configurando um Bloco de Comunicação OPC UA para ter a propriedade Size
igual a 20, o número máximo válido para esta propriedade é 19 e o mínimo é 0 (zero). Esta propriedade pode ser
alterada após iniciada a comunicação. O valor padrão desta propriedade é 0 (zero), porém ao mapear os Elementos
de um Bloco de Comunicação OPC UA o Elipse E3 Studio automaticamente configura esta propriedade para um valor
de acordo com o especificado.
Quality
Esta propriedade representa o estado de qualidade do valor contido na propriedade Value. Esta propriedade é
somente de leitura.

NOTA
Para mais informações sobre qualidade, consulte o tópico Qualidade no Manual do Usuário do Elipse E3.

RawValue
Acessa o valor original do Elemento de Bloco de Comunicação OPC UA anterior à escala, ou seja, independente da
configuração da propriedade EnableScaling. Portanto, se esta propriedade está configurada para Falso, a
propriedade Value e esta propriedade apresentam o mesmo comportamento.
UseBitFields
Caso esta propriedade esteja configurada para Verdadeiro, toda vez que o valor da propriedade Value é
modificado, atualiza os bits referentes às propriedades de Bit00 até Bit31. Da mesma forma, atualiza o valor de
Value toda vez que alguma das propriedades de Bit00 até Bit31 mudar de valor e posteriormente envia para um
equipamento ou dispositivo se a propriedade AllowWrite do Bloco de Comunicação OPC UA está configurada para
Verdadeiro. Caso contrário, se esta propriedade está 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 de um Servidor OPC UA, de acordo com a especificação da
propriedade ItemID do Bloco de Comunicação OPC UA onde este objeto está inserido, e considerando a propriedade
Index, que especifica a posição do Elemento de Bloco de Comunicação OPC UA no vetor do Bloco de Comunicação
OPC UA. O tipo de dados desta propriedade, tais como número inteiro, ponto flutuante ou texto, depende do Driver
de Comunicação OPC UA ao qual está associado e da configuração.

338 Objetos de Servidor

Esta propriedade somente é atualizada desta forma se a propriedade AllowRead do objeto Bloco de Comunicação
OPC UA ao qual o Elemento de Bloco de Comunicação OPC UA pertence está configurada para Verdadeiro, e de
acordo com o tempo de varredura definido na propriedade Scan da Assinatura OPC UA que contêm o Bloco de
Comunicação OPC UA. Se a propriedade AllowWrite do objeto Bloco de Comunicação OPC UA está configurada para
Verdadeiro, pode-se escrever valores em um equipamento ou dispositivo simplesmente atribuindo um novo valor
para esta propriedade.
Esta também é a propriedade padrão do objeto Elemento de Bloco OPC UA. Sendo assim, uma referência por valor a
um objeto Elemento de Bloco OPC UA não necessita obrigatoriamente explicitar esta propriedade para acessar o
valor. Caso esta propriedade não esteja sendo atualizada, verifique se a propriedade Index está corretamente
configurada, ou seja, o valor deve ser entre 0 (zero) e o tamanho do Bloco de Comunicação OPC UA menos um.

[Link].3 Pasta
O objeto Pasta da Assinatura OPC UA (UaFolder) não possui eventos, métodos ou propriedades específicos
associados, somente métodos e propriedades gerais. Estes podem ser visualizados nas seções Eventos, Métodos e
Propriedades Gerais dos Objetos.

[Link].4 Tag de Comunicação OPC UA

Esta seção contém informações sobre eventos, métodos e propriedades do objeto Tag de Comunicação OPC UA
(UaTag).

[Link].4.1 Eventos
Esta seção contém informações sobre os eventos do objeto Tag de Comunicação OPC UA (UaTag).
OnRead
OnRead()
Ocorre quando um valor do Tag de Comunicação OPC UA é recebido de um Servidor OPC UA. Utilize este evento para
efetuar alguma operação logo após algum dado ter sido modificado no objeto Tag de Comunicação OPC UA, nas
propriedades Bit00 até Bit31, Quality, RawValue, TimeStamp ou Value.

[Link].4.2 Métodos
Esta seção contém informações sobre os métodos do objeto Tag de Comunicação OPC UA (UaTag).
Write
Write()
Executa a escrita do valor corrente do Tag de Comunicação OPC UA em um equipamento. Para mais detalhes, consulte
a documentação do Driver. Este método retorna um Booleano que indica o sucesso ou não da operação.
WriteEx
WriteEx([Value], [NewTimestamp], [NewQuality], [SyncWrite])
Executa a escrita de um valor em um equipamento. Todos os parâmetros são opcionais. Se omitidos, o
comportamento deste método é igual ao do método Write. Este método retorna um Booleano que indica o sucesso
ou não da operação. O parâmetro Value define o valor a ser escrito no Driver. O tipo de dados depende do Driver. Se
omitido, assume o valor corrente do Tag de Comunicação OPC UA. Os parâmetros NewTimestamp e NewQuality
indicam, respectivamente, a estampa de tempo e a qualidade do valor, caso a propriedade WriteValueMode esteja
configurada para 2 - wvmValueQualityTimestamp. O parâmetro SyncWrite é um Booleano que especifica se a
operação descrita deve ser síncrona (Verdadeiro) ou assíncrona (Falso). Se omitido, usa o valor especificado na
propriedade SyncWrite do Tag de Comunicação OPC UA.

NOTA
Assim como no método Write, a escrita é realizada independente de o valor ser diferente do valor atual do Tag de
Comunicação OPC UA, bem como independente da propriedade AllowWrite do Tag de Comunicação OPC UA estar
configurada para Verdadeiro ou Falso. Além disto, se a escrita funciona mas o Tag de Comunicação OPC UA não
está em scan, seja porque a propriedade AllowRead está configurada para Falso ou porque usa a opção
AdviseWhenLinked quando não está sendo associado, o valor escrito é assumido imediatamente com qualidade
boa e estampa de tempo do momento da escrita.

Objetos de Servidor 339

[Link].4.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Tag de Comunicação OPC UA (UaTag).
AdviseType
Controla o modo Advise. As opções disponíveis estão descritas na tabela a seguir.
Opções disponíveis para a propriedade AdviseType
OPÇÃO DESCRIÇÃO
0 - AlwaysInAdvise O Tag de Comunicação OPC UA é mantido atualizado se
a propriedade AllowRead está configurada para
Verdadeiro e a propriedade Enable da Assinatura OPC
UA também está configurada para Verdadeiro

1 - AdviseWhenLinked O Tag de Comunicação OPC UA só é atualizado se a

propriedade AllowRead e a propriedade Enable da
Assinatura OPC UA estão configuradas para Verdadeiro,
e o Tag de Comunicação OPC UA está associado a algum
objeto ativo, como por exemplo um Display de uma Tela
aberta ou um Alarme habilitado, entre outros. A
associação do Tag de Comunicação OPC UA para este
propósito pode ser realizada nas propriedades Value,
RawValue, TimeStamp, Quality e de Bit00 até Bit31 de
Tags de Comunicação OPC UA (padrão)

AllowRead
Define se este Tag de Comunicação OPC UA deve ou não ser lido pela Assinatura OPC UA. Caso a propriedade
esteja configurada para Verdadeiro, a Assinatura OPC UA automaticamente atualiza as propriedades Value, de Bit00
até Bit31, e RawValue deste objeto em intervalos de tempo. Caso contrário, este Tag de Comunicação OPC UA não é
lido. Esta propriedade não pode ser alterada com o objeto ativo. O valor padrão desta propriedade é Verdadeiro.
AllowWrite
Define se este Tag de Comunicação OPC UA deve ou não ser escrito automaticamente quando as propriedades
Value, qualquer uma das propriedades de Bit00 até Bit31, ou RawValue são modificadas. Se esta propriedade está
configurada para Verdadeiro, as modificações são enviadas para o equipamento ou dispositivo associado à
Assinatura OPC UA. Do contrário, as modificações são ignoradas. O valor padrão desta propriedade é Verdadeiro.
Bit00 até Bit31
Estas propriedades representam juntas os 32 bits do valor presente na propriedade Value do objeto Tag de
Comunicação OPC UA, em que Bit00 representa o bit menos significativo e Bit31 representa o bit mais significativo.
Modificar cada um destes bits implica em modificar também a propriedade Value do Tag de Comunicação OPC UA e
vice-versa, mas isto somente ocorre quando a propriedade UseBitFields está configurada para Verdadeiro. O valor
padrão desta propriedade é Falso.
DataType
Propriedade preenchida quando o Elipse E3 se conecta ao servidor OPC UA, que indica o tipo de dados no
servidor OPC UA. Esta propriedade é inicialmente preenchida no processo de busca (browsing), se realizado, e em
cada comunicação ou conexão com um Servidor OPC UA. Valores abaixo de 1000 são escalares e valores acima de
1000 são vetores (arrays). Esta propriedade é somente de leitura. Os valores possíveis para esta propriedade estão
descritos na tabela a seguir.
Valores possíveis para a propriedade DataType
VALOR DESCRIÇÃO
-1 udtUnknown (Valor desconhecido, item desconectado ou
tipo de dados não suportado pelo Elipse E3)

0 udtNull

1 udtBoolean

2 udtSByte

3 udtByte

4 udtInt16

340 Objetos de Servidor

 VALOR DESCRIÇÃO
5 udtUInt16

6 udtInt32

7 udtUInt32

8 udtInt64 (consulte a nota a seguir)

9 udtUInt64 (consulte a nota a seguir)

10 udtFloat

11 udtDouble

12 udtString

13 udtDateTime

14 udtGuid (Identificador único global de 128 bits,

formatado como texto no Elipse E3)

15 udtByteString (Vetor de bytes ou uma String binária)

16 udtXmlElement (Elemento XML, formatado como texto no

Elipse E3)

17 udtNodeId (Identificador de Nó OPC UA, formatado

como um vetor de três elementos no Elipse E3)

18 udtExpandedNodeId (Identificador de Nó OPC UA

expandido, formatado como um vetor de três elementos
no Elipse E3)

19 udtStatusCode (Equivalente à qualidade, indica erros)

20 udtQualifiedName (Texto com o Namespace, que no

Elipse E3 é descartado)

21 udtLocalizedText (Texto com o locale, que no Elipse E3 é

descartado)

22 udtStructure (Indica que é um tipo de dados complexo

do OPC UA, mas não específico, formatado como um
vetor onde cada elemento é um membro da estrutura)

23 udtDataValue (Valor com a qualidade e a estampa de

tempo, que no Elipse E3 são descartados)

24 udtVariant (Valor com tipo de dados variável ou

indefinido)

25 udtDiagnosticInfo

1000 udtArrayUnknown (Vetor genérico, de tipos de dados

não conhecidos)

1001 udtArrayBoolean

1002 udtArraySByte

1003 udtArrayByte

1004 udtArrayInt16

1005 udtArrayUInt16

1006 udtArrayInt32

1007 udtArrayUInt32

1008 udtArrayInt64

1009 udtArrayUInt64

1010 udtArrayFloat

Objetos de Servidor 341

 VALOR DESCRIÇÃO
1011 udtArrayDouble

1012 udtArrayString

1013 udtArrayDateTime

1014 udtArrayGuid

1015 udtArrayByteString

1016 udtArrayXmlElement

1017 udtArrayNodeId

1018 udtArrayExpandedNodeId

1019 udtArrayStatusCode

1020 udtArrayQualifiedName

1021 udtArrayLocalizedText

1022 udtArrayStructure

1023 udtArrayDataValue

1024 udtArrayVariant

NOTAS
· Apesar de o padrão OPC UA permitir valores de 64 bits, atualmente no Elipse E3 as propriedades de Bit00 até
Bit31 permitem apenas controlar os primeiros 32 bits menos significativos.
· Estruturas definidas por Servidores OPC UA específicos, não compatíveis com o padrão OPC UA, não são lidas
pelo Elipse E3.
· Tipos de dados complexos com valores abaixo de 1000 devem ser usados em Blocos de Comunicação OPC UA.
· Os tipos de dados udtQualifiedName, udtArrayQualifiedName, udtLocalizedText, udtArrayLocalizedText,
udtStructure, udtArrayStructure, udtDataValue, udtArrayDataValue, udtUnknown e udtArrayUnknown não
permitem a escrita na versão atual do Elipse E3, pois o Elipse E3 utiliza uma formatação simplificada destes tipos
de dados.
· Os tipos de dados ServiceCounterDataType (array de duas posições), BuildIndfo (array de seis posições),
Argument (array de seis posições), ApplicationDescription (array de oito posições),
SessionDiagnosticsDataType (array de 44 posições), SessionSecurityDiagnosticsDataType (array de 10
posições), SubscriptionsDiagnosticsDataType (array de 31 posições), ServerDiagnosticsSummaryDataType
(array de 12 posições), ServerStatusDataType (array de seis posições), EuInformation (array de quatro posições),
Range (array de duas posições), TimeZoneDataType (array de duas posições), DiagnosticInfo (array de sete
posições), StatusResult (array de duas posições), ComplexNumberType (array de duas posições),
DoubleComplexNumberType (array de duas posições), XVType (array de duas posições),
RedundanteServerSataType (array de três posições), SamplingIntervalDiagnosticsDataType (array de quatro
posições), EnumValueType (array de três posições), EndpointUrlListDataType (array de duas posições) e
NetworkGroupDataType (array de três posições) são mostrados como udtStructure, mas o Elipse E3 trata o tipo
de dados específico.
· Na versão atual, o Elipse E3 só permite vetores de uma dimensão, ou seja, não permite matrizes como tipos de
dados.

DeviceHigh
Esta propriedade define o valor máximo atingido por um Tag de Comunicação OPC UA em um equipamento ou
dispositivo. Esta propriedade é utilizada para executar o ajuste de escala do valor proveniente de um equipamento ou
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 os valores permanecem os mesmos. O valor padrão desta
propriedade é 1000.

342 Objetos de Servidor

NOTA
Os valores dos bits, ou seja, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é,
representam os bits do valor lido de um equipamento antes da conversão.

DeviceLow
Esta propriedade define o valor mínimo atingido por um Tag de Comunicação OPC UA em um equipamento ou
dispositivo. Esta propriedade é utilizada para executar o ajuste de escala do valor proveniente de um equipamento ou
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).

NOTA
Os valores dos bits, ou seja, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é,
representam os bits do valor lido de um equipamento antes da conversão.

EnableDriverEvent
Esta propriedade é utilizada para controlar a geração do evento OnTagRead, que ocorre no Driver de
Comunicação OPC UA que contém o Tag de Comunicação OPC UA. Se esta propriedade está configurada para
Verdadeiro, a cada leitura vinda de um Servidor OPC UA, seja com erro ou não, é gerado o evento OnTagRead no
objeto Driver de Comunicação OPC UA que contém este Tag de Comunicação OPC UA. Caso contrário, este evento
não ocorre. Também quando esta propriedade está configurada para Verdadeiro, a cada escrita que seja enviada
para um Servidor OPC UA é gerado o evento OnTagWrite no objeto Driver de Comunicação OPC UA que contém o
Tag de Comunicação OPC UA. Se a escrita é assíncrona, este evento é gerado apenas quando o Servidor OPC UA
enviar a resposta indicando o efetivo sucesso ou não da escrita. Neste caso, o evento é gerado apenas se esta
propriedade está configurada para Verdadeiro neste momento, e não no momento do envio da escrita. O valor
padrão desta propriedade é Falso.
EnableScaling
Se esta propriedade está configurada para Verdadeiro, todo valor proveniente de um equipamento ou dispositivo
sofre ajuste de escala conforme as propriedades EUHigh e EULow antes de ser atribuído à propriedade Value. Caso
esta propriedade esteja configurada para Falso, nenhum ajuste de escala é efetuado em nenhum dos dois sentidos,
tanto para escrita como para leitura. O valor padrão desta propriedade é Falso.
EU
Identifica a unidade de engenharia representada pelo valor, como por exemplo graus, metros ou KW/h. O valor
padrão desta propriedade é vazio.
EUHigh
Define qual o valor máximo que deve ser atribuído à propriedade Value, ajustando a escala ao valor de um
equipamento ou 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 é 1000.

NOTA
Os valores dos bits, ou seja, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é,
representam os bits do valor lido de um equipamento antes da conversão.

EULow
Define qual o valor mínimo que deve ser atribuído à propriedade Value, ajustando a escala ao valor de um
equipamento ou 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).

NOTA
Os valores dos bits, ou seja, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é,
representam os bits do valor lido de um equipamento antes da conversão.

Objetos de Servidor 343

ItemID
Especifica o caminho para realizar a busca, ou browsing, de um Tag de Comunicação OPC UA em um Servidor OPC
UA. Este caminho é usado no método RefreshUaNodeIds do Driver de Comunicação OPC UA para recuperar o
Identificador de Nó OPC UA de um Tag de Comunicação OPC UA, quando desejado.
Quality
Esta propriedade informa qual a qualidade do valor contido na propriedade Value. Cada vez que a Assinatura OPC
UA atribui um novo valor para o Tag de Comunicação OPC UA, também configura a qualidade daquele dado. Esta
propriedade é somente de leitura. O valor padrão desta propriedade é 0 (zero, qualidade ruim).

NOTA
Para mais informações sobre qualidade, consulte o tópico Qualidade no Manual do Usuário do Elipse E3.

RawValue
Acessa o valor original do Tag de Comunicação OPC UA anterior à escala, ou seja, independente da configuração da
propriedade EnableScaling. Portanto, se esta propriedade está configurada para Falso, a propriedade Value e esta
propriedade apresentam o mesmo comportamento.
SyncWrite
Esta propriedade determina o tipo de escrita usada por um Tag de Comunicação OPC UA. Se esta propriedade está
configurada para Verdadeiro, a escrita é síncrona, isto é, a Assinatura OPC UA espera o resultado da escrita do
Servidor OPC UA. Caso contrário, a escrita é assíncrona, isto é, o valor do Tag de Comunicação OPC UA é enviado e o
processamento da Assinatura OPC UA continua imediatamente. O valor padrão desta propriedade é Falso.

NOTA
No modo assíncrono, com esta propriedade configurada para Falso, a performance da comunicação tende a ser
melhor, porém no modo síncrono, com esta propriedade configurada para Verdadeiro, o sucesso da operação de
escrita é verificado e informado.

TimeStamp
Esta propriedade é atualizada sempre que ocorre 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 UA. Esta propriedade é somente de leitura. O valor padrão desta propriedade é "00:00:00".
UaNodeId
Especifica o caminho para realizar a busca, ou browsing, de um Tag de Comunicação OPC UA em um Servidor OPC
UA. Este caminho é usado no método RefreshUaNodeIds do Driver de Comunicação OPC UA para recuperar o
Identificador de Nó OPC UA de um Tag de Comunicação OPC UA, quando desejado. Esta propriedade deve estar
preenchida para estabelecer a comunicação com um Servidor OPC UA.
UseBitFields
Caso esta propriedade esteja configurada para Verdadeiro, toda vez que o valor da propriedade Value é
modificado, atualiza os bits referentes às propriedades de Bit00 até Bit31. Da mesma forma, atualiza o valor de
Value toda vez que alguma das propriedades de Bit00 até Bit31 mudar de valor e posteriormente envia para um
equipamento ou dispositivo se a propriedade AllowWrite está configurada para Verdadeiro. Caso contrário, se esta
propriedade está configurada para Falso, os bits não sofrem qualquer mudança. Esta propriedade pode sofrer
atualização após ter sido iniciada a comunicação. O valor padrão desta propriedade é Falso.

NOTA
Os valores dos bits, ou seja, as propriedades de Bit00 até Bit31, não são afetados pelo ajuste de escala, isto é,
representam os bits do valor lido de um equipamento antes da conversão.

Value
Esta propriedade é atualizada quando é executada uma nova leitura válida de um valor de um equipamento ou
dispositivo utilizando a configuração, porém o tipo de dados desta variável, tais como número inteiro, ponto flutuante
ou texto, depende do Driver de Comunicação OPC UA ao qual está associado e da configuração. Esta propriedade
somente é atualizada desta forma se a propriedade AllowRead está 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 na Assinatura OPC UA ao qual o Tag de Comunicação OPC UA pertence.
Outra forma de utilizar esta propriedade é escrever valores em um equipamento ou dispositivo. Basta que se atribua

344 Objetos de Servidor

um novo valor para esta propriedade ou algum dos bits das propriedades de Bit00 até Bit31, desde que a
propriedade AllowWrite esteja configurada para Verdadeiro. Esta propriedade também é a propriedade padrão do
objeto Tag de Comunicação OPC UA. Sendo assim, uma referência por valor a um objeto Tag de Comunicação OPC
UA não necessita obrigatoriamente explicitar esta propriedade para acessar o valor. O valor padrão desta
propriedade é vazio.
WriteValueMode
Propriedade de leitura e escrita que controla o comportamento do envio de um valor nas operações de escrita.
Esta propriedade deve ser configurada de acordo com o Servidor OPC UA utilizado, pois do contrário a escrita falha.
Os valores possíveis para esta propriedade são 0 - wvmDefault: Segue o comportamento padrão, isto é, o
comportamento configurado no Driver de Comunicação OPC UA a que este Tag de Comunicação OPC UA pertence, 1
- wvmValueOnly: Escreve apenas o valor ou 2 - wvmValueQualityTimestamp: Envia sempre a qualidade e a
estampa de tempo junto com o valor.

5.6 Fórmulas
Esta seção contém informações sobre métodos e propriedades do objeto Fórmula (Formula). Este objeto não possui
eventos associados.

5.6.1 Métodos
Esta seção contém informações sobre os métodos do objeto Fórmula (Formula).

[Link] 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 Verdadeiro se a operação é realizada com sucesso ou Falso em caso de falha.

[Link] CreateValue
CreateValue(ValueName)
Cria um Conjunto de Valores na tabela de Fórmulas. Este método possui o parâmetro ValueName, que determina o
nome do Conjunto de Valores a ser criado. Retorna Verdadeiro se a operação é realizada com sucesso ou Falso em
caso de falha.

[Link] 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 Verdadeiro se a operação é realizada com sucesso ou Falso em caso de falha.

[Link] DeleteValue
DeleteValue(ValueName)
Apaga um Conjunto de Valores na tabela de Fórmulas. Este método possui o parâmetro ValueName, que informa o
nome do Conjunto de Valores a ser apagado. Retorna Verdadeiro se a operação é realizada com sucesso ou Falso
em caso de falha.

[Link] 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 Verdadeiro se a operação é
realizada com sucesso ou Falso em caso de falha.

[Link] 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 de Valores a ser encontrado. Retorna Verdadeiro se a
operação é realizada com sucesso ou Falso em caso de falha.

Objetos de Servidor 345

[Link] GetUnitData
GetUnitData(UnitName, TemplateName, Val)
Coloca na variável indicada em Val o Tag associado à Unidade UnitName do Template TemplateName. Retorna
Verdadeiro se a operação é realizada com sucesso ou Falso em caso de falha.

[Link] GetValueData
GetValueData(ValueName, TemplateName, Val)
Coloca na variável Val o valor do Conjunto de Valores ValueName que está associado ao Template TemplateName.
Retorna Verdadeiro se a operação é realizada com sucesso ou Falso em caso de falha.

[Link] LoadFormulaValuesQuiet
LoadFormulaValuesQuiet(UnitName, ValueName)
Carrega um Conjunto de Valores para uma Unidade de destino, sem apresentar nenhuma mensagem. Este método
possui os parâmetros UnitName, que determina o nome da Unidade, e ValueName, que determina o nome do
Conjunto de Valores. Retorna Verdadeiro se a operação é realizada com sucesso ou Falso em caso de falha. Isto não
significa um erro de script, necessariamente.

NOTA
Este método também é acessado através do objeto Viewer.

[Link] RenameUnit
RenameUnit(UnitName, NewUnitName)
Renomeia uma determinada Unidade existente na tabela de Fórmulas. 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. Retorna
Verdadeiro se a operação é realizada com sucesso ou Falso em caso de falha.

[Link] RenameValue
RenameValue(ValueName, NewValueName)
Renomeia um determinado Conjunto de Valores existente na tabela de Fórmulas. 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. Retorna Verdadeiro se a operação é realizada com sucesso ou Falso em caso de falha.

[Link] SaveFormulaValues
SaveFormulaValues(UnitName, ValueName, [IgnoreErrors])
Salva os valores atuais dos Tags de uma Unidade de origem em um Conjunto de Valores na tabela de Fórmulas. Este
método possui os parâmetros UnitName, que indica o nome da Unidade de origem, ValueName, que indica o
Conjunto de Valores que é salvo, e IgnoreErrors, um Booleano opcional que permite que se grave ou não todos os
valores, independente de haver erros nas associações da Fórmula. Se este parâmetro é omitido, os valores não são
gravados. Este método não realiza a verificação de limites se o Template tem uma restrição do tipo Absoluta.

[Link] SetUnitData
SetUnitData(UnitName, TemplateName, Data)
Carrega para a tabela de Fórmulas o Tag identificado para um certo Template, em uma determinada Unidade. 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 do Tag a ser atribuído à Unidade. Retorna Verdadeiro se a operação é
realizada com sucesso ou Falso em caso de falha.

[Link] SetValueData
SetValueData(ValueName, TemplateName, Data)
Altera o valor referente a um Template definido para um determinado Conjunto de Valores. Este método possui os
parâmetros ValueName, que determina o nome do Conjunto de Valores, TemplateName, que determina o nome do

346 Objetos de Servidor

Template, e Data, que determina o valor a ser atribuído ao Conjunto de Valores. Este método realiza a verificação dos
limites e retorna Verdadeiro se a operação é realizada com sucesso ou Falso em caso de falha.

NOTA
Para mais informações sobre este método consulte os artigos Trabalhando com Fórmulas no Elipse E3, Criando um
conjunto de valores durante a execução e Modificando um conjunto de valores em tempo de execução no Elipse
Knowledgebase.

5.6.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Fórmula (Formula).

[Link] DataSourceSize
Indica o tamanho máximo dos campos de Unidades na tabela do Banco de Dados. O valor padrão desta
propriedade é 200 e seu valor deve ser positivo.

NOTA
· O tipo de dados desta propriedade é um inteiro de 32 bits, mas é dependente do tipo de dados definido pelo
servidor de banco de dados utilizado (Access, SQL Server ou Oracle).
· Alterar esta propriedade para um valor menor do que o previamente configurado pode resultar em truncamento
dos dados já armazenados na tabela do Banco de Dados.

[Link] DBServer
Indica o nome do banco de dados onde sã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.

[Link] ImmediateExecute
Quando habilitada, esta propriedade permite que a Fórmula escreva seus registros diretamente no Banco de Dados
sem precisar passar por suas filas de operações, ou seja, os arquivos .e3i e .e3o. Isto permite que as operações
realizadas no Banco de Dados sejam visualizadas de forma mais rápida.

[Link] TableName
Indica o nome das tabelas onde são armazenadas as informações das Fórmulas. O valor padrão desta propriedade
é uma String vazia.

[Link] ValueSize
Indica o tamanho máximo dos campos de Valores na tabela do Banco de Dados. O valor padrão desta propriedade
é 200 e seu valor deve ser positivo.

NOTA
· O tipo de dados desta propriedade é um inteiro de 32 bits, mas é dependente do tipo de dados definido pelo
servidor de banco de dados utilizado (Access, SQL Server ou Oracle).
· Alterar esta propriedade para um valor menor do que o previamente configurado pode resultar em truncamento
dos dados já armazenados na tabela do Banco de Dados.

5.7 Históricos
Esta seção contém informações sobre métodos e propriedades do objeto Histórico (Hist). Este objeto não possui
eventos associados.

5.7.1 Métodos
Esta seção contém informações sobre os métodos do objeto Histórico (Hist).

Objetos de Servidor 347

[Link] StartAcquisition
StartAcquisition()
Habilita o Histórico a gravar os valores do seus campos periodicamente, a partir da taxa especificada na propriedade
ScanTime. Este método pode ser utilizado a qualquer momento após utilizar o método StopAcquisition. O
comportamento padrão deste método é iniciar a aplicação habilitado, ou seja, este método é sempre executado
internamente ao se iniciar o Histórico. O script a seguir contém um exemplo de uso deste método.
Sub Botao1_Click()
' Ao clicar neste botão, habilita o Histórico.
[Link]("Hist1").StartAcquisition()
End Sub

[Link] 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. O script a seguir contém
um exemplo de uso deste método.
Sub Hist1_OnStartRunning()
' Desabilita o Histórico assim que iniciar.
StopAcquisition()
End Sub

[Link] WriteRecord
WriteRecord()
Insere um novo registro 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 um novo registro antes do tempo previsto para a próxima gravação quando o Histórico está
habilitado por tempo
· Para gravar um novo registro quando o Histórico está desabilitado

O script a seguir contém um exemplo de uso deste método.

Sub Tag1_OnValueChange()
' Grava um novo registro em um Histórico
' quando um Tag muda de valor.
[Link]("Hist1").WriteRecord()
End Sub

5.7.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Histórico (Hist).

[Link] BackupDiscardInterval
Indica o intervalo máximo de tempo, em minutos, horas, dias ou meses, dos dados na tabela de backup do Histórico
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).

NOTA
O tempo total indicado pela combinação desta propriedade e da propriedade BackupDiscardTimeUnit deve ser
maior que o tempo indicado pelas propriedades DiscardInterval e DiscardTimeUnit.

[Link] BackupDiscardTimeUnit
Esta propriedade indica a unidade de tempo em que os dados de backup do Histórico permanecem armazenados
até serem descartados. As opções disponíveis são 0 - dtHour: Horas, 1 - dtDay: Dias, 2 - dtMonth: Meses (padrão)
ou 3 - dtMinute: Minutos. Esta propriedade trabalha em conjunto com a propriedade BackupDiscardInterval.

348 Objetos de Servidor

[Link] 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 esta propriedade é 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).

NOTA
O bloco de registros é enviado a cada um segundo, mesmo que não tenha atingido o tamanho configurado nesta
propriedade.

[Link] CompressedTable
Habilita o uso de banda morta para a gravação de dados. O valor padrão desta propriedade é Falso.

[Link] 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.

[Link] DeadBand
Esta propriedade trabalha em conjunto com a propriedade CompressedTable e indica o valor calculado sobre o
último valor gravado, em percentagem, que define se este novo valor é gravado. Se o valor gravado não é numérico,
sua modificação força todos os valores a serem gravados.

[Link] DiscardInterval
Esta propriedade trabalha em conjunto com a propriedade DiscardTimeUnit e 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 é
configurada com um valor menor ou igual ao valor da propriedade BackupDiscardInterval, o Elipse E3
automaticamente ajusta o valor de BackupDiscardInterval como o dobro do valor desta propriedade.

[Link] DiscardTimeUnit
Esta propriedade trabalha em conjunto com a propriedade DiscardInterval e indica a unidade de tempo em que
os dados do Histórico permanecem armazenados até serem descartados. As opções disponíveis são 0 - dtHour:
Horas, 1 - dtDay: Dias, 2 - dtMonth: Meses (padrão) ou 3 - dtMinute: Minutos.

[Link] EnableBackupTable
Cria uma tabela de backup onde os dados descartados do Histórico 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.

[Link] EnableDiscard
Indica descarte dos dados do Histórico 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.

[Link] EnableQualityLogs
Quando em Verdadeiro, ao iniciar o Histórico o Elipse E3 gera um registro igual ao primeiro registro coletado, mas
com qualidade ruim (0) e estampa de tempo de um segundo antes.

[Link] Fields
Esta propriedade retorna um objeto que representa a coleção de Campos criados em um Histórico. Esta
propriedade é somente de leitura. Para mais informações sobre o objeto retornado nesta propriedade, consulte o
tópico Fields.

Objetos de Servidor 349

NOTAS
· Em aplicações criadas antes da versão 5.0 do Elipse E3, esta propriedade é uma coleção padrão, que suporta o
método Item para acessar os Campos disponíveis. A partir da versão 5.0, esta propriedade também retorna um
objeto nativo do Elipse E3 e, portanto, a forma de acesso aos Campos é diferente para ambas as formas. O
exemplo a seguir demonstra a forma correta de utilização desta propriedade.
· Aplicações salvas na versão 5.0 convertem os objetos Histórico do formato de coleção para objeto nativo e NÃO
podem mais ser abertas em versões anteriores.

Para acessar a coleção de Campos de Histórico tanto como uma coleção quanto como um objeto nativo, use a sintaxe
descrita no exemplo a seguir.
'A aplicação contém um objeto chamado Hist1
'que contém um Campo chamado Campo1.
'Para acessar este Campo a partir de uma coleção,
'use a seguinte sintaxe:
Set campoColecao = [Link]("Hist1").[Link]("Campo1")
'Para acessar este mesmo Campo como um objeto nativo,
'use a seguinte sintaxe:
Set campoNativo = [Link]("[Link].Campo1")

[Link] 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.

[Link] TableName
Define o nome da tabela utilizada no Histórico.

[Link] 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 E3. Esta
propriedade é somente de leitura.

[Link] UseTagQuality
Se esta propriedade está configurada para Verdadeiro, o Histórico usa o valor de qualidade da fonte do Tag. Caso
contrário, utiliza o método antigo de avaliação, ou seja, 0: Valor duvidoso ou 1: Valor bom.

[Link] VerificationInterval
Esta propriedade trabalha em conjunto com a propriedade VerificationUnit para controlar o intervalo de tempo
que o Elipse E3 verifica a antiguidade dos dados do Histórico, para depois descartá-los. O valor padrão desta
propriedade é 1 (uma unidade de tempo indicada na propriedade VerificationUnit).

[Link] VerificationUnit
Esta propriedade trabalha em conjunto com a propriedade VerificationInterval e indica a unidade de tempo em
que é realizada a verificação para descarte dos dados do Histórico. As opções disponíveis são 0 - dtHour: Horas, 1 -
dtDay: Dias, 2 - dtMonth: Meses (padrão) ou 3 - dtMinute: Minutos.

5.7.3 Fields
Esta seção contém informações sobre métodos e propriedades do objeto Fields (HistFieldsCollection). Este objeto
não possui eventos associados.

NOTA
O objeto Fields pode ser acessado através da propriedade Fields do Histórico.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Fields (HistFieldsCollection).

350 Objetos de Servidor

[Link].1 AddField
AddField([Name], [SourceLink], [Type], [Size])
Este método adiciona um novo Campo de Histórico no objeto Fields e retorna o objeto criado. Em caso de erro, este
método retorna Nothing. Todos os parâmetros deste método são opcionais. A tabela a seguir contém a descrição de
cada um dos parâmetros.
Parâmetros do método AddField
PARÂMETRO DESCRIÇÃO
Name Nome do Campo de Histórico. Se este parâmetro é
omitido, o nome recebe a expressão "Campo" e é
autoincrementado, se necessário. Este parâmetro
corresponde à propriedade Name do Campo de
Histórico. Consulte a propriedade geral Name para mais
informações sobre os caracteres permitidos nos nomes
de objetos

SourceLink Fonte de dados do Campo de Histórico. Se este

parâmetro é omitido, a fonte de dados recebe uma
String vazia. Este parâmetro corresponde à propriedade
Link do Campo de Histórico

Type Tipo de dados do Campo de Histórico. Se este

parâmetro é omitido, o tipo de dados é configurado
como 1: Integer. Este parâmetro corresponde à
propriedade Type do Campo de Histórico

Size Tamanho do Campo de Histórico. Se este parâmetro é

omitido, o tamanho do Campo de Histórico recebe o
valor 0 (zero). Este parâmetro corresponde à
propriedade Size do Campo de Histórico

NOTA
Para Históricos cuja tabela no Banco de Dados seja criada pelo usuário, este método retorna um erro.

[Link].2 DeleteField
DeleteField(Index)
Remove o Campo de Histórico informado no parâmetro Index, que pode ser a posição do Campo de Histórico
(iniciando em um) ou o valor da propriedade Name do Campo de Histórico, se este Campo de Histórico existir no
objeto Fields. Caso contrário, este método retorna um erro de script.

NOTA
O Campo de Histórico E3TimeStamp, criado automaticamente pelo Elipse E3, não pode ser removido.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Fields (HistFieldsCollection).

[Link].1 Count
Retorna a quantidade de objetos Campo de Histórico no objeto Fields. Esta propriedade é somente de leitura.

[Link] Campo de Histórico

Esta seção contém informações sobre as propriedades do objeto Campo de Histórico (HistField). Este objeto não
possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Campo de Histórico (HistField).

Objetos de Servidor 351

[Link].1.1 Field
Esta propriedade determina o nome do Campo de Histórico na tabela do banco de dados. O valor padrão desta
propriedade é uma String vazia, ou seja, usa o valor da propriedade Name como nome do Campo na tabela do
banco de dados. Se esta propriedade contém um valor diferente de uma String vazia, este valor é usado como o
nome deste Campo de Histórico na tabela do banco de dados.

NOTA
Para aplicações criadas em versões anteriores à versão 5.0 e abertas na versão 5.0 ou mais recente em que a
propriedade Name contém um valor que não pode ser usado como nome de objeto no Elipse E3, a expressão
"Campo_" é concatenada ao valor da propriedade Name e usada como nome deste Campo de Histórico na tabela
do banco de dados.

[Link].1.2 Link
Esta propriedade determina a fonte de dados associada ao Campo de Histórico. Esta propriedade não pode ser
alterada em tempo de execução em tabelas criadas pelo Histórico, apenas em tabelas criadas pelo usuário.

[Link].1.3 Name
Esta propriedade retorna ou configura o nome deste Campo de Histórico no objeto Histórico. Através desta
propriedade é possível buscar itens na Coleção de Campos de Histórico, ou seja, na propriedade Fields. O valor
padrão desta propriedade é uma String vazia. Não é permitido utilizar as expressões "Null", "Empty", "Nothing",
"Application", "True" ou "False" para esta propriedade. Consulte a propriedade geral Name para mais informações
sobre os caracteres permitidos no nome deste objeto.

[Link].1.4 PrimaryKey
Esta propriedade indica se este Campo de Histórico é usado na definição da chave primária do Histórico. O valor
padrão desta propriedade é Falso.

[Link].1.5 Size
Esta propriedade indica o tamanho do Campo de Histórico. O valor desta propriedade geralmente é usado para
Campos de Histórico cuja propriedade Type seja igual a 0: fdText. Este valor não pode ser negativo e seu valor
padrão é 0 (zero).

[Link].1.6 Type
Esta propriedade indica o tipo de dados do Campo de Histórico. Os valores possíveis para esta propriedade são
0: fdText, 1: fdInteger, 2: fdDouble ou 3: fdDateTime. O valor padrão desta propriedade é 1: fdInteger.

5.7.4 Indexes
Este objeto representa todos os Índices disponíveis em um Histórico e não contém eventos, métodos ou propriedades
específicos, somente gerais. Estes podem ser visualizados na seção Eventos, Métodos e Propriedades Gerais dos
Objetos.

NOTA
O objeto Indexes não pode ser inserido em um Histórico com tabelas criadas pelo usuário.

[Link] Índice de Histórico

Esta seção contém informações sobre as propriedades do objeto Índice de Histórico (HistIndex). Este objeto não
possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Índice de Histórico (HistIndex).

352 Objetos de Servidor

[Link].1.1 IndexName
Esta propriedade indica o nome deste Índice na tabela do banco de dados. O valor padrão desta propriedade é
uma String vazia. Neste caso, usa o nome do objeto como nome do Índice. Se esta propriedade é preenchida, o valor
deve ser único entre os Índices criados para o Histórico.

[Link].1.2 Unique
Esta propriedade define se os Campos que compõem este Índice devem ter registros únicos na tabela do banco de
dados. O valor padrão desta propriedade é Falso.

[Link].2 Campo de Índice

Esta seção contém informações sobre as propriedades do objeto Campo de Índice (HistIndexField). Este objeto não
possui eventos nem métodos associados.

[Link].2.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Campo de Índice (HistIndexField).
Field
Esta propriedade define o nome de um campo na tabela do banco de dados usado como Índice no Histórico. O
valor padrão desta propriedade é uma String vazia.
Order
Esta propriedade define a ordenação deste Campo no Índice. As opções disponíveis para esta propriedade são 0:
foAscending (padrão) ou 1: foDescending.

5.7.5 PrimaryKey
Esta seção contém informações sobre as propriedades do objeto PrimaryKey. Este objeto não tem eventos nem
métodos associados e representa todas as Chaves Primárias disponíveis em um Histórico.

NOTA
O objeto PrimaryKey não pode ser inserido em um Histórico com tabelas criadas pelo usuário.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto PrimaryKey.

[Link].1 KeyName
Esta propriedade indica o nome desta Chave Primária na tabela do banco de dados. O valor padrão desta
propriedade é "E3Index".

[Link] Campo de Chave Primária

Esta seção contém informações sobre as propriedades do objeto Campo de Chave Primária (HistPrimaryKeyField).
Este objeto não possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Campo de Chave Primária (HistPrimaryKeyField).

[Link].1.1 Field
Esta propriedade define o nome de um campo na tabela do banco de dados usado como Chave Primária no
Histórico. O valor padrão desta propriedade é uma String vazia.

[Link].1.2 Order
Esta propriedade define a ordenação deste Campo na Chave Primária. As opções disponíveis para esta
propriedade são 0: foAscending (padrão) ou 1: foDescending.

Objetos de Servidor 353

5.8 Informações do Servidor
Esta seção contém informações sobre as propriedades do objeto Informações do Servidor (ServerNode). Este objeto
não possui eventos nem métodos associados.

NOTAS
· Este objeto e todos os objetos filhos possuem as propriedades gerais Count, Name e Parent, além do método
geral Item. Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta
coleção.
· A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?Server]", é obrigatória.

5.8.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Informações do Servidor (ServerNode).

[Link] ProductString
Retorna o nome do produto e a versão do servidor, como por exemplo "Elipse E3 6.8.148". Esta propriedade é
somente de leitura.

5.8.2 Informações da Sessão

Esta seção contém informações sobre propriedades do objeto Informações da Sessão (SessionNodeBase). Este
objeto não possui eventos nem métodos associados.

NOTA
A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?
Server].[Link]", é obrigatória.

Os objetos Informações da Sessão atualmente disponíveis são os seguintes:

· RemoteDomains: Conexões de Domínios remotos
· Studios: Conexões de Elipse E3 Studios
· Viewers: Conexões de Elipse E3 Viewers

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Informações da Sessão (SessionNodeBase).

[Link].1 Address
Retorna o endereço IPv4 do computador cliente, no formato [Link], onde XXX é um valor entre 0
(zero) e 255. Esta propriedade é somente de leitura.

[Link].2 Machine
Retorna o nome do computador cliente. Esta propriedade é somente de leitura.

[Link].3 ReadOnly
Indica se a sessão do cliente está no modo somente leitura. Esta propriedade é somente de leitura.

NOTA
Esta propriedade não está disponível para os objetos de sessões Studios, em "[?Server].[Link]".

[Link].4 StartTime
Indica a data e hora do estabelecimento da conexão com um cliente. Esta propriedade é somente de leitura.

354 Objetos de Servidor

[Link].5 User
Retorna o nome de login do usuário da sessão ou uma String vazia no caso de um usuário anônimo. Esta
propriedade é somente de leitura.

[Link].6 Version
Retorna a versão de um cliente, como por exemplo "6.8.148". Esta propriedade é somente de leitura.

5.8.3 Informações das Licenças

Esta seção contém informações sobre propriedades do objeto Informações das Licenças (LicenseNode). Este objeto
não possui eventos nem métodos associados.

NOTAS
· Este objeto e todos os objetos filhos possuem as propriedades gerais Count, Name e Parent, além do método
geral Item. Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta
coleção.
· A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?Server].License", é
obrigatória.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Informações das Licenças (LicenseNode).

[Link].1 DbAvailable
Indica se a licença atual permite o recurso de Bancos de Dados. Esta propriedade é somente de leitura.

[Link].2 DeviceType
Indica o tipo de dispositivo da licença atual. Os valores possíveis para esta propriedade são 0: Não encontrado, 1:
HASP, 2: TimeHasp ou 3: Softkey. Esta propriedade é somente de leitura.

[Link].3 ErrorMessage
Retorna a mensagem de erro relacionada à licença atual ou uma String vazia caso não haja nenhuma mensagem de
erro, que é o valor padrão. Esta propriedade é somente de leitura.

[Link].4 ExpireDate
Indica a data de expiração da licença atual ou 0 (zero) se a licença atual não tem data de expiração. Esta
propriedade é somente de leitura.

[Link].5 ID
Retorna o identificador único do dispositivo de proteção da licença atual ou uma String vazia caso o Elipse E3
esteja em modo Demonstração. Esta propriedade é somente de leitura.

[Link].6 IsDemo
Indica se a licença atual está em modo de Demonstração, ou seja, não foi encontrada nenhuma licença válida. Esta
propriedade é somente de leitura.

[Link].7 MaxRuntime
Indica o tempo máximo permitido de execução de um Domínio, em minutos. Esta propriedade é somente de leitura.

[Link].8 OpcClientAvailable
Indica se a licença atual permite a utilização de um Cliente OPC DA. Esta propriedade é somente de leitura.

[Link].9 ReportsAvailable
Indica se a licença atual permite a utilização do recurso de Relatórios de Seção. Esta propriedade é somente de
leitura.

Objetos de Servidor 355

[Link].10 TrendAnalysisAvailable
Indica se a licença atual permite a utilização do recurso de TrendAnalysis. Esta propriedade é somente de leitura.

[Link].11 UaClientAvailable
Indica se a licença atual permite a utilização de um Cliente OPC UA. Esta propriedade é somente de leitura.

[Link].12 VersionRange
Indica o intervalo de versões permitido pela licença atual, como por exemplo "4.7-5.0", ou seja, a licença atual pode
ser utilizada entre as versões 4.7 e 5.0. Esta propriedade é somente de leitura.

[Link] Informações dos Tipos de Licenças

Esta seção contém informações sobre propriedades do objeto Informações dos Tipos de Licenças
(LicenseCounterNode). Este objeto não possui eventos nem métodos associados.

NOTA
A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?Server].[Link]", é
obrigatória.

Os objetos Informações dos Tipos de Licenças atualmente disponíveis são os seguintes:

· ViewersControl: Licenças de Elipse E3 Viewer
· ViewersOnly: Licenças de Elipse E3 Viewer Only
· Studios: Licenças de Elipse E3 Studio
· IoPoints: Licenças de pontos de entrada e saída
· StorageTags: Licenças de Tags de Storage
· RemoteServers: Licenças de Domínios remotos servidores
· RemoteClients: Licenças de Domínios remotos clientes
· OpcServer: Licenças de Servidor OPC DA
· IoDrivers: Licenças de Drivers para qualquer Driver, ou seja, licenças ilimitadas de Drivers
· IoDriversId<nnn>: Licenças de Drivers, em que nnn é um valor numérico entre 1 (um) e 65535, quando há licenças
para um ID específico de Driver de entrada e saída
· UaServerTagLimit: Licenças de Servidor OPC UA

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Informações das Licenças (LicenseNode).

[Link].1.1 IsUnlimited
Indica se o Tipo de Licença atual é ilimitado, ou seja, o valor da propriedade Limit não é usado. Esta propriedade é
somente de leitura.

[Link].1.2 Limit
Indica o limite de licenças para o Tipo de Licença atual ou -1 (menos um) se o Tipo de Licença atual é ilimitado. Esta
propriedade é somente de leitura.

[Link].1.3 Used
Indica o número total de licenças já consumidas pelo Tipo de Licença atual. Esta propriedade é somente de leitura.

5.8.4 Informações de Segurança

O objeto Informações de Segurança (SecurityNode) não tem eventos, métodos ou propriedades específicos
associados, somente as propriedades gerais Count, Name e Parent, além do método geral Item. Também é possível
utilizar a declaração For Each em scripts para enumerar os objetos filhos desta coleção.

356 Objetos de Servidor

NOTA
A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?Server].Security", é obrigatória.

[Link] Informações de Grupos

Esta seção contém informações sobre métodos do objeto Informações de Grupos (GroupsNode). Este objeto não
possui eventos nem propriedades associados.

NOTAS
· Este objeto e todos os objetos filhos possuem as propriedades gerais Count, Name e Parent, além do método
geral Item. Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta
coleção.
· A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?Server].[Link]", é
obrigatória.

[Link].1 Métodos
Esta seção contém informações sobre os métodos do objeto Informações de Grupos (GroupsNode).

[Link].1.1 CreateGroup
CreateGroup(Name, Type)
Cria um grupo com o nome indicado no parâmetro Name e o tipo indicado no parâmetro Type. Os valores possíveis
para o parâmetro Type são 0: Grupo do Elipse E3 ou 1: Grupo do Windows. Este método falha caso o grupo indicado
no parâmetro Name já exista ou se este parâmetro é uma String vazia.

NOTA
O acesso a este método só é permitido a usuários com permissão para configurar usuários e grupos. Para mais
informações, consulte o tópico Segurança - Usuários no Manual do Usuário do Elipse E3.

[Link].1.2 GroupExists
GroupExists(Name)
Retorna Verdadeiro se o grupo indicado pelo parâmetro Name existe ou Falso se este grupo não existe.

NOTA
O acesso a este método só é permitido a usuários com permissão para configurar usuários e grupos. Para mais
informações, consulte o tópico Segurança - Usuários no Manual do Usuário do Elipse E3.

[Link].1.3 RemoveGroup
RemoveGroup(Name)
Remove o grupo indicado pelo parâmetro Name. Este método falha caso o parâmetro Name indique um grupo
inexistente.

NOTA
O acesso a este método só é permitido a usuários com permissão para configurar usuários e grupos. Para mais
informações, consulte o tópico Segurança - Usuários no Manual do Usuário do Elipse E3.

[Link].2 Informações de um Grupo

Esta seção contém informações sobre métodos e propriedades do objeto Informações de um Grupo (GroupNode).
Este objeto não possui eventos associados.

Objetos de Servidor 357

NOTA
· Este objeto e todos os objetos filhos possuem as propriedades gerais Count, Name e Parent, além do método
geral Item. Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta
coleção.
· A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?
Server].[Link].Nome_Grupo", é obrigatória.

[Link].2.1 Métodos
Esta seção contém informações sobre os métodos do objeto Informações de um Grupo (GroupNode).
AddToGroup
AddToGroup(GroupName)
Adiciona um grupo ao grupo indicado no parâmetro GroupName. Este método falha se o grupo indicado no
parâmetro GroupName não existe ou é uma referência inválida, ou seja, é um grupo do Windows ou um grupo que já
pertence a este grupo direta ou indiretamente.

NOTA
O acesso a este método só é permitido a usuários com permissão para configurar usuários e grupos. Para mais
informações, consulte o tópico Segurança - Usuários no Manual do Usuário do Elipse E3.

RemoveFromGroup
RemoveFromGroup(GroupName)
Remove o grupo indicado pelo parâmetro GroupName de um grupo. Este método falha caso o parâmetro
GroupName indique um grupo inexistente.

NOTA
O acesso a este método só é permitido a usuários com permissão para configurar usuários e grupos. Para mais
informações, consulte o tópico Segurança - Usuários no Manual do Usuário do Elipse E3.

[Link].2.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Informações de um Grupo (GroupNode).
Type
Indica o tipo de um grupo. Os valores possíveis para esta propriedade são 0: Grupo do Elipse E3 ou 1: Grupo do
Windows. Esta propriedade é somente de leitura.

NOTA
O acesso a esta propriedade só é permitido a usuários com permissão para configurar usuários e grupos. Para mais
informações, consulte o tópico Segurança - Usuários no Manual do Usuário do Elipse E3.

[Link] Informações de Usuários

Esta seção contém informações sobre métodos do objeto Informações de Usuários (UsersNode). Este objeto não
possui eventos nem propriedades associados.

NOTAS
· Este objeto e todos os objetos filhos possuem as propriedades gerais Count, Name e Parent, além do método
geral Item. Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta
coleção.
· A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?Server].[Link]", é
obrigatória.

[Link].1 Métodos
Esta seção contém informações sobre os métodos do objeto Informações de Usuários (UsersNode).

358 Objetos de Servidor

[Link].1.1 CreateUser

CreateUser(Name, Type, IsAdmin, [FullName], [Password])

Cria um novo usuário. Os parâmetros deste método são os seguintes:
· Name: Nome do usuário a ser criado
· Type: Tipo do usuário a ser criado. Os valores possíveis para este parâmetro são 0: Usuário do Elipse E3 ou 1:
Usuário do Windows
· IsAdmin: Indica se este usuário é um administrador ou não
· FullName: Nome completo deste usuário. Este parâmetro é opcional se o parâmetro Type é igual a 1 (um,
usuário do Windows) e obrigatório se o parâmetro Type é igual a 0 (zero, usuário do Elipse E3)
· Password: Senha deste usuário. Este parâmetro é opcional se o parâmetro Type é igual a 1 (um, usuário do
Windows) e obrigatório se o parâmetro Type é igual a 0 (zero, usuário do Elipse E3)

NOTAS
· O acesso a este método só é permitido a usuários com permissão para configurar usuários e grupos. Se o
parâmetro IsAdmin é igual a Verdadeiro e já existe ao menos um usuário administrador configurado, o acesso a
este método só é permitido a administradores. Para mais informações, consulte o tópico Segurança - Usuários no
Manual do Usuário do Elipse E3.
· Este método só funciona se já existir um usuário administrador na aplicação e, no caso de ser usado para criar
outro usuário administrador, é necessário que um usuário administrador esteja logado.

[Link].1.2 RemoveUser
RemoveUser(Name)
Remove o usuário indicado no parâmetro Name. Este método falha caso o parâmetro Name indique um usuário
inexistente.

NOTA
O acesso a este método só é permitido a usuários com permissão para configurar usuários e grupos. Se o usuário
indicado é um administrador, o acesso a este método só é permitido para administradores. Para mais informações,
consulte o tópico Segurança - Usuários no Manual do Usuário do Elipse E3.

[Link].1.3 UserExists

UserExists(Name)
Retorna Verdadeiro se o usuário indicado pelo parâmetro Name existe ou Falso se este usuário não existe.

NOTA
O acesso a este método só é permitido a usuários com permissão para configurar usuários e grupos. Para mais
informações, consulte o tópico Segurança - Usuários no Manual do Usuário do Elipse E3.

[Link].2 Informações de um Usuário

Esta seção contém informações sobre métodos e propriedades do objeto Informações de um Usuário (UserNode).
Este objeto não possui eventos associados.

NOTA
· Este objeto e todos os objetos filhos possuem as propriedades gerais Count, Name e Parent, além do método
geral Item. Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta
coleção.
· A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?
Server].[Link].Nome_Usuario", é obrigatória.

[Link].2.1 Métodos
Esta seção contém informações sobre os métodos do objeto Informações de um Usuário (UserNode).

Objetos de Servidor 359

AddToGroup
AddToGroup(GroupName)
Adiciona um usuário ao grupo indicado pelo parâmetro GroupName. Este método falha se o grupo indicado no
parâmetro GroupName não existe.

NOTA
O acesso a este método só é permitido a usuários com permissão para configurar usuários e grupos. Se o usuário é
um administrador, o acesso a este método só é permitido para administradores. Para mais informações, consulte o
tópico Segurança - Usuários no Manual do Usuário do Elipse E3.

RemoveFromGroup
RemoveFromGroup(GroupName)
Remove um usuário do grupo indicado pelo parâmetro GroupName. Este método falha caso o parâmetro GroupName
indique um grupo inexistente.

NOTA
O acesso a este método só é permitido a usuários com permissão para configurar usuários e grupos. Se o usuário é
um administrador, o acesso a este método só é permitido para administradores. Para mais informações, consulte o
tópico Segurança - Usuários no Manual do Usuário do Elipse E3.

[Link].2.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Informações de um Usuário (UserNode).
FullName
Retorna ou configura o nome completo de um usuário.

NOTA
O acesso a esta propriedade só é permitido a usuários com permissão para configurar usuários e grupos. Se o
usuário é um administrador, o acesso à escrita nesta propriedade só é permitido para administradores. Para mais
informações, consulte o tópico Segurança - Usuários no Manual do Usuário do Elipse E3.

IsAdministrator
Retorna ou configura se um usuário é administrador.

NOTA
O acesso a esta propriedade só é permitido a usuários com permissão para configurar usuários e grupos. O acesso
à escrita nesta propriedade só é permitido para administradores. Para mais informações, consulte o tópico
Segurança - Usuários no Manual do Usuário do Elipse E3.

Password
Configura a senha de um usuário. Esta propriedade é somente de escrita.

NOTA
O acesso a esta propriedade só é permitido a usuários com permissão para configurar usuários e grupos. Se o
usuário é um administrador, o acesso à escrita nesta propriedade só é permitido para administradores. Para mais
informações, consulte o tópico Segurança - Usuários no Manual do Usuário do Elipse E3.

Type
Retorna ou configura o tipo de um usuário. Os valores possíveis para esta propriedade são 0: Usuário do Elipse
E3 ou 1: Usuário do Windows.

NOTA
O acesso a esta propriedade só é permitido a usuários com permissão para configurar usuários e grupos. Se o
usuário é um administrador, o acesso à escrita nesta propriedade só é permitido para administradores. Para mais
informações, consulte o tópico Segurança - Usuários no Manual do Usuário do Elipse E3.

360 Objetos de Servidor

5.8.5 Informações do Domínio
Esta seção contém informações sobre métodos e propriedades do objeto Informações do Domínio (DomainNode).
Este objeto não possui eventos associados.

NOTA
· Este objeto e todos os objetos filhos possuem as propriedades gerais Count, Name e Parent, além do método
geral Item. Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta
coleção.
· A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?Server].Domain", é
obrigatória.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Informações do Domínio (DomainNode).

[Link].1 Refresh
Refresh()
Força a atualização do Domínio atual.

NOTA
· Este método não pode ser utilizado a partir de um Viewer Read-Only.
· Ao utilizar este método pelo Elipse E3 Viewer ou pelo Domínio, há uma verificação se o usuário logado tem
permissão para esta ação, de acordo com as configurações do Domínio.

[Link].2 Stop
Stop()
Para o Domínio em execução.

NOTA
· Este método não pode ser utilizado a partir de um Viewer Read-Only.
· Ao utilizar este método pelo Elipse E3 Viewer ou pelo Domínio, há uma verificação se o usuário logado tem
permissão para esta ação, de acordo com as configurações do Domínio.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Informações do Domínio (DomainNode).

[Link].1 Domain
Nome amigável de um Domínio, configurado no item Nome do Domínio do grupo Geral na aba Propriedades da
janela de configurações de um Domínio. Esta propriedade é somente de leitura.

[Link].2 FullPath
Caminho completo de um arquivo de Domínio. Esta propriedade é somente de leitura.

[Link].3 HotStandby
Retorna Verdadeiro se o modo Hot-Standby está habilitado em um Domínio. Esta propriedade é somente de
leitura.

[Link].4 State
Indica o estado de um Domínio, local ou remoto. Os valores possíveis para esta propriedade são -1: Fechado ou
sem Domínio, 0: Parado mas carregado, 1: Em modo Hot-Standby ou 2: Executando. Esta propriedade é somente de
leitura.

Objetos de Servidor 361

[Link] Informações dos Arquivos do Domínio
O objeto Informações dos Arquivos do Domínio (AppFilesNode) não tem eventos, métodos ou propriedades
específicos associados, somente as propriedades gerais Count, Name e Parent, além do método geral Item.
Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta coleção.

NOTA
A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?Server].[Link]", é
obrigatória.

[Link].1 Informações dos Arquivos de Biblioteca do Domínio

O objeto Informações dos Arquivos de Biblioteca do Domínio (LibFilesNode) não tem eventos, métodos ou
propriedades específicos associados, somente as propriedades gerais Count, Name e Parent, além do método geral
Item. Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta coleção.

NOTA
A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?Server].[Link]", é
obrigatória.

[Link].1.1 Informações de um Arquivo de Biblioteca do Domínio

Esta seção contém informações sobre propriedades do objeto Informações de um Arquivo de Biblioteca do Domínio
(LibFileNode). Este objeto não possui eventos nem métodos associados.

NOTA
A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?
Server].[Link].Nome_Biblioteca", é obrigatória.

Propriedades
Esta seção contém informações sobre propriedades do objeto Informações de um Arquivo de Biblioteca do Domínio
(LibFileNode).
FileVersionMaj
Contém o número principal da versão de um arquivo de biblioteca. Corresponde ao número principal da coluna
Versão na janela Relatório de Versões do Elipse E3 Studio. Esta propriedade é somente de leitura.
FileVersionMin
Contém o número secundário da versão de um arquivo de biblioteca. Corresponde ao número secundário da coluna
Versão na janela Relatório de Versões do Elipse E3 Studio. Esta propriedade é somente de leitura.
PathVolume
Caminho completo de um arquivo de biblioteca. Esta propriedade é somente de leitura.

[Link].2 Informações dos Arquivos de Pacotes de Bibliotecas do Domínio

O objeto Informações dos Arquivos de Pacotes de Bibliotecas do Domínio (PkgFilesNode) não tem eventos, métodos
ou propriedades específicos associados, somente as propriedades gerais Count, Name e Parent, além do método
geral Item. Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta
coleção.

NOTA
A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?Server].[Link]", é
obrigatória.

[Link].2.1 Informações de um Arquivo de Pacote de Bibliotecas do Domínio

Esta seção contém informações sobre propriedades do objeto Informações de um Arquivo de Pacote de Bibliotecas
do Domínio (PkgFileNode). Este objeto não possui eventos nem métodos associados.

362 Objetos de Servidor

NOTA
A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?
Server].[Link].Nome_Pacote", é obrigatória.

Propriedades
Esta seção contém informações sobre propriedades do objeto Informações de um Arquivo de Pacote de Bibliotecas
do Domínio (PkgFileNode).
FileVersionMaj
Contém o número principal da versão de um arquivo de pacote de bibliotecas. Corresponde ao número principal da
coluna Versão na janela Relatório de Versões do Elipse E3 Studio. Esta propriedade é somente de leitura.
FileVersionMin
Contém o número secundário da versão de um arquivo de pacote de bibliotecas. Corresponde ao número
secundário da coluna Versão na janela Relatório de Versões do Elipse E3 Studio. Esta propriedade é somente de
leitura.
PathVolume
Caminho completo de um arquivo de pacote de bibliotecas. Esta propriedade é somente de leitura.

[Link].3 Informações dos Arquivos de Projeto do Domínio

O objeto Informações dos Arquivos de Projeto do Domínio (PrjFilesNode) não tem eventos, métodos ou propriedades
específicos associados, somente as propriedades gerais Count, Name e Parent, além do método geral Item.
Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta coleção.

NOTA
A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?Server].[Link]", é
obrigatória.

[Link].3.1 Informações de um Arquivo de Projeto do Domínio

Esta seção contém informações sobre propriedades do objeto Informações de um Arquivo de Projeto do Domínio
(PrjFileNode). Este objeto não possui eventos nem métodos associados.

NOTA
A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?
Server].[Link].Nome_Projeto", é obrigatória.

Propriedades
Esta seção contém informações sobre propriedades do objeto Informações de um Arquivo de Projeto do Domínio
(PrjFileNode).
DocString
Retorna a propriedade DocString de um arquivo de projeto. Esta propriedade é somente de leitura.
Enabled
Permite habilitar ou desabilitar um arquivo de projeto.
FileVersionMaj
Contém o número principal da versão de um arquivo de projeto. Corresponde ao número principal da coluna
Versão na janela Relatório de Versões do Elipse E3 Studio. Esta propriedade retorna -1 (menos um) se um arquivo
de projeto está desabilitado ou 0 (zero) caso haja algum erro de carregamento de um arquivo de projeto. Esta
propriedade é somente de leitura.
FileVersionMin
Contém o número secundário da versão de um arquivo de projeto. Corresponde ao número secundário da coluna
Versão na janela Relatório de Versões do Elipse E3 Studio. Esta propriedade é somente de leitura.
PathVolume
Caminho completo de um arquivo de projeto. Esta propriedade é somente de leitura.

Objetos de Servidor 363

[Link] Informações dos Servidores do Domínio
Esta seção contém informações sobre propriedades do objeto Informações dos Servidores do Domínio
(DomainServerNode). Este objeto não possui eventos nem métodos associados.

NOTA
A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?
Server].[Link]", é obrigatória.

Os objetos Informações dos Servidores do Domínio atualmente disponíveis são LocalServer (Servidor do Domínio
local) e RemoteServer (Servidor do Domínio remoto).

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Informações dos Servidores do Domínio
(DomainServerNode).

[Link].1.1 Connection
Indica uma mensagem de diagnóstico sobre o estado atual da conexão de um servidor local com um servidor
remoto. Corresponde ao texto da coluna Conexão da lista Servidores conectados da janela Monitor do E3 Admin.
Esta propriedade é somente de leitura e só está disponível para o objeto RemoteServer.

[Link].1.2 Disabled
Configura um servidor como desabilitado ou em manutenção.

NOTA
Ao modificar o valor desta propriedade pelo E3Run, considera-se esta ação sempre permitida e associada ao
usuário System, o mesmo usuário que reconhece alarmes automaticamente. Ao modificar o valor desta propriedade
pelo Elipse E3 Viewer ou pelo Domínio, há uma verificação se o usuário logado tem permissão para esta ação, de
acordo com as configurações do Domínio.

[Link].1.3 DomainState
Indica o estado de um Domínio em um servidor remoto. Os valores possíveis para esta propriedade são -1:
Fechado ou sem Domínio ou 2: Executando. Normalmente o valor desta propriedade é o mesmo valor da
propriedade State do objeto Informações do Domínio se o outro servidor está com o mesmo Domínio carregado.
Esta propriedade é somente de leitura e só está disponível para o objeto RemoteServer.

[Link].1.4 FailuresWeight
Indica o peso total de falhas ativas em um servidor ou 0 (zero) para indicar que um servidor está em modo Hot e
apresenta falhas. Esta propriedade é somente de leitura.

[Link].1.5 IsCandidate
Indica se um servidor está pronto ou não para assumir a execução de um Domínio. Esta propriedade é somente de
leitura.

[Link].1.6 IsIoActive
Indica se há servidores de I/O executando em um servidor. Esta propriedade é somente de leitura.

[Link].1.7 IsPrioritySet
Indica se um servidor requisitou ou não prioridade de execução, ou seja, se um servidor requisitou ou não
prioridade para ser o servidor ativo. Esta propriedade é somente de leitura.

[Link].1.8 NetworkAddress
Indica o nome de um servidor na rede. Este nome corresponde ao nome de host, não ao endereço IPv4. Esta
propriedade é somente de leitura.

364 Objetos de Servidor

[Link].1.9 Online
Retorna Verdadeiro se a conexão com um servidor remoto está funcionando. Esta propriedade é somente de leitura
e só está disponível para o objeto RemoteServer.

[Link].1.10 Ping
Indica se o comando ping realizado de um servidor local para um servidor remoto está funcionando ou não, ou
seja, se há resposta. Esta propriedade é somente de leitura e só está disponível para o objeto RemoteServer.

[Link].1.11 ServerName
Indica o nome ou alias de um servidor, conforme a configuração do Domínio. Esta propriedade é somente de
leitura.

[Link].1.12 State
Retorna o estado de execução de um Domínio em um servidor. Para servidores locais, o valor possível para esta
propriedade é 2: Executando. Para servidores remotos, os valores possíveis para esta propriedade são -1: Fechado
ou sem Domínio ou 1: Em modo Hot-Standby. Esta propriedade é somente de leitura.

[Link] Informações de Servidores Remotos

O objeto Informações de Servidores Remotos (RemoteDomainServerNode) não tem eventos, métodos ou
propriedades específicos associados, somente as propriedades gerais Count, Name e Parent, além do método geral
Item. Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta coleção.

NOTA
A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?
Server].[Link]", é obrigatória.

[Link].1 Informações de um Servidor Remoto

Esta seção contém informações sobre propriedades do objeto Informações de um Servidor Remoto
(RemoteDomainNode). Este objeto não possui eventos nem métodos associados.

NOTA
A utilização de colchetes na referência a este objeto em scripts, como por exemplo "[?
Server].[Link].Nome_Dominio", é obrigatória.

[Link].1.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Informações de um Servidor Remoto
(RemoteDomainNode).
ActiveServer
Indica o nome do servidor remoto com a conexão ativa, caso a conexão esteja estabelecida, ou uma String vazia se
o servidor remoto não está conectado.
BackupAddress
Indica o endereço de um servidor remoto secundário para um Domínio remoto ou uma String vazia se o servidor
remoto secundário está desabilitado.
Connected
Indica se há uma conexão estabelecida no momento com algum servidor remoto, principal ou secundário.
DomainFile
Indica o nome do arquivo de Domínio configurado para um Domínio remoto.
LastError
Mensagem de diagnóstico sobre o motivo da falha de conexão com o servidor principal ou uma String vazia caso
haja uma conexão ativa.

Objetos de Servidor 365

LastErrorBackup
Mensagem de diagnóstico sobre o motivo da falha de conexão com o servidor secundário ou uma String vazia
caso haja uma conexão ativa.
ServerAddress
Indica o endereço do servidor remoto principal para um Domínio remoto ou uma String vazia se o servidor
principal está desabilitado.

5.9 Objetos em Tempo de Configuração

Esta seção contém informações sobre objetos que só podem ser utilizados em tempo de configuração.

5.9.1 E3StudioApplication
Esta seção contém informações sobre métodos e propriedades do objeto E3StudioApplication. Este objeto não
possui eventos associados.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto E3StudioApplication.

NOTA
Os métodos aqui descritos só podem ser utilizados no Elipse E3 Studio, não estando disponíveis em tempo de
execução.

[Link].1 BlockUndo
BlockUndo()
Bloqueia todas as operações de desfazer (undo) até o final da execução de um script. O uso deste método não afeta
o histórico de operações de desfazer já existentes.

[Link].2 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 Elipse E3 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 é omitido, utiliza 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 é 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. Se este parâmetro é omitido, o assistente de configuração é aberto
· OpenView: Booleano que indica se o Editor do objeto inserido é aberto após a execução deste método. Se este
parâmetro é omitido, o Editor do objeto é aberto

Valores possíveis para o parâmetro ClassName

OBJETO A SER CRIADO VALOR DO PARÂMETRO
Banco de Dados [Link]

Configuração de Alarmes [Link]

Driver de Comunicação [Link]

Driver de Comunicação OPC [Link]

366 Objetos de Servidor

 OBJETO A SER CRIADO VALOR DO PARÂMETRO
Driver de Comunicação OPC UA [Link]

Fórmula [Link]

Histórico [Link]

Quadro [Link]

Relatório de Seção Panel.E3SectionReport

Servidor de Alarmes [Link]

Servidor de Dados [Link]

Storage [Link]

Tela [Link]

Viewer [Link]

[Link].3 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 Elipse E3 Studio
· Se o parâmetro FolderName é vazio, utiliza-se 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 este parâmetro é omitido, a nova Pasta é criada na
raiz do arquivo de projeto

[Link].4 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 é um caminho absoluto, utiliza-se 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.

[Link].5 DeleteFile
DeleteFile(PRJName, FileName, [Folder])
Apaga um objeto em um arquivo de projeto (.prj). Os parâmetros deste método são os seguintes:
· PRJName: O nome do arquivo de projeto que contém o objeto a ser apagado. Este parâmetro não pode ser
vazio e o arquivo de projeto deve estar carregado no Elipse E3 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
· FileName: O nome do objeto a ser apagado
· Folder: O nome da Pasta onde o objeto deve ser apagado. Se este parâmetro é omitido, o objeto é excluído da
raiz do arquivo de projeto

[Link].6 ListFiles
ListFiles([FileClass], [Domain])
Retorna uma coleção de objetos de uma determinada classe em um Domínio. Os parâmetros deste método são os
seguintes:
· FileClass: 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 é omitido, retorna uma coleção com todos os objetos do

Objetos de Servidor 367

 Domínio especificado. Se o Domínio especificado não contém nenhum objeto da classe informada, este método
retorna uma coleção vazia, ou seja, com zero itens
· Domain: Uma String opcional com o nome de um Domínio remoto. Se este parâmetro é omitido, especifica o
Domínio local. Se o Domínio remoto não existir, este método retorna um erro de script

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 com a
declaração For Each do VBScript.

NOTAS
· O método Item da coleção retornada por este método permite o acesso somente pelo índice numérico (iniciando
em um).
· Ao omitir o parâmetro Domain, e portanto retornar uma coleção de objetos no Domínio local, é possível listar
objetos do contexto de visualização, ou seja, Elipse E3 Viewers, Telas e Quadros. Nos casos em que o parâmetro
Domain indica um Domínio remoto, os objetos do contexto de visualização daquele Domínio não são retornados
por este método.

[Link].7 RenameFolder
RenameFolder(OldName, NewName)
Permite renomear uma Pasta em um arquivo de projeto aberto no Elipse E3 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 caminho completo da Pasta no parâmetro OldName ou o novo nome no parâmetro NewName, começa com
um caractere que não seja uma letra (sem acentos nem "ç"), ou se possui um caractere qualquer que não seja uma
letra (sem acentos nem "ç"), um algarismo (0-9) ou sublinhado, é obrigatório o uso de colchetes no nome.
· Se o parâmetro NewName é inválido, se o parâmetro OldName contém um erro de sintaxe, ou ainda se o caminho
indicado em OldName não foi encontrado em nenhum arquivo de projeto aberto, ocorre um erro de script.
· Arquivos de projeto protegidos por senha devem ser desbloqueados antes da utilização deste método.

[Link].8 Trace
Trace(MessageText, [LogTimeStamp], [BreakLine])
Este método permite registrar mensagens no log do Elipse E3. Este método pode ser usado, por exemplo, para
registrar mensagens de depuração de scripts executados no Elipse E3 Studio.
Parâmetros do método Trace
PARÂMETRO DESCRIÇÃO
MessageText Mensagem definida pelo usuário

LogTimeStamp Booleano que indica se cada registro deve ter a data e a

hora (timestamp). Este parâmetro é opcional e é
ignorado no Elipse E3 Studio

BreakLine Booleano que indica a presença ou não de uma quebra

de linha ao final de cada mensagem. Este parâmetro é
opcional e é ignorado no Elipse E3 Studio

[Link].9 Verify
Verify(OutputFile, [ObjectLink], [FixQuestionsDefault])
Executa uma verificação de erros no Domínio atual e exporta uma lista de erros encontrados durante esta verificação
para um arquivo no formato CSV (Comma-Separated Values). Os parâmetros deste método são os seguintes:
· OutputFile: Caminho onde deve ser salvo o arquivo com a lista de erros encontrados
· ObjectLink: Caminho para um objeto do Domínio a ser verificado. Se este parâmetro é omitido, a verificação é
realizada em todo o Domínio

368 Objetos de Servidor

 · FixQuestionsDefault: Indica como devem ser tratados os erros que podem ser consertados automaticamente
pelo Elipse E3 Studio. Os valores possíveis são 0 (zero, padrão), equivalente a responder Não para todos na
opção Verificação de Domínio do Elipse E3 Studio, e 1 (um), equivalente a responder Sim para todos na opção
Verificação de Domínio do Elipse E3 Studio. Neste caso, os erros corrigidos não são incluídos no arquivo de
saída

O arquivo gerado contém as colunas Objeto, Erro, Descrição e Solução. Este método retorna o total de erros
encontrados durante a verificação.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto E3StudioApplication.

NOTA
As propriedades aqui descritas só podem ser utilizadas no Elipse E3 Studio, não estando disponíveis em tempo de
execução.

[Link].1 ProductString
Esta propriedade contém uma String com o nome do produto e a versão do Elipse E3 Studio, como por exemplo
"Elipse E3 6.8.148" ou "Elipse E3 (64-bits) 6.8.148". Esta propriedade é somente de leitura.

[Link].2 ProductVersionBuild
Esta propriedade contém o número de build da versão do Elipse E3 Studio. Por exemplo, se a versão instalada é a
6.8.148, esta propriedade contém o valor 148. Esta propriedade é somente de leitura.

[Link].3 ProductVersionMajor
Esta propriedade contém o número principal da versão do Elipse E3 Studio. Por exemplo, se a versão instalada é a
6.8.148, esta propriedade contém o valor 6. Esta propriedade é somente de leitura.

[Link].4 ProductVersionMinor
Esta propriedade contém o número secundário da versão do Elipse E3 Studio. Por exemplo, se a versão instalada é
a 6.8.148, esta propriedade contém o valor 8. Esta propriedade é somente de leitura.

5.10 Objetos em Tempo de Execução do Servidor

Esta seção contém informações sobre objetos que só podem ser utilizados em tempo de execução, o Servidor
(ServerApplicationE3) e a Pasta de Aplicativo (RuntimeFolder).

5.10.1 Pasta de Aplicativo

O objeto Pasta de Aplicativo (RuntimeFolder) é semelhante ao objeto Pasta de Dados, do objeto Servidor de Dados,
permitindo agrupar objetos do Servidor dentro de pastas. Contudo, existem diferenças importantes:
· O objeto Pasta de Aplicativo só está disponível em tempo de execução
· O objeto Pasta de Aplicativo possui as propriedades gerais Application, Count, Name, Parent e PathName,
além dos métodos gerais Item e Save
· O objeto Pasta de Aplicativo permite utilizar a declaração For Each para enumerar os objetos filhos, mas este
acesso leva em conta apenas os objetos do Servidor, não listando, por exemplo, Telas e Recursos que estejam
dentro das Pastas
· A pasta raiz a partir da qual é possível enumerar os objetos é sempre o objeto Servidor

5.10.2 Servidor
Esta seção contém informações sobre métodos e propriedades do objeto Server (ServerApplicationE3). 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. Este objeto não possui eventos associados.

Objetos de Servidor 369

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Servidor (ServerApplicationE3).

NOTA
Os métodos aqui descritos só podem ser utilizados em tempo de execução, não estando disponíveis no Elipse E3
Studio.

[Link].1 AckFailure
AckFailure(FailureName)
Este método deve ser usado para reconhecer uma falha gerada pelo método ReportFailure e, consequentemente,
remover esta falha da lista de falhas do E3 Admin. O parâmetro FailureName indica o nome desta falha, definida pelo
usuário.

[Link].2 ClearFailure
ClearFailure(FailureName)
Este método deve ser usado para indicar que uma falha reportada pelo método 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 este é usado.

[Link].3 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 está
atualmente tratando uma operação gerada por outro processo, retorna a String "System". Se não há nenhum usuário
logado no processo que gerou a requisição atual, retorna a String "Anonymous".

[Link].4 IsUserMemberOfGroup
IsUserMemberOfGroup(GroupName, [UserName])
Este método verifica se um usuário pertence a um determinado grupo de usuários. O parâmetro GroupName indica o
nome do grupo de usuários a ser verificado e o parâmetro UserName indica o nome do usuário a ser verificado. Se
este parâmetro é omitido ou é igual a uma String vazia, este método considera o usuário retornado pelo método
E3GetActor. Este método retorna Verdadeiro se o usuário pertence ao grupo de usuários indicado no parâmetro
GroupName ou Falso caso contrário.

[Link].5 LoadReport
LoadReport(ReportName)
Carrega um modelo de Relatório de Seção. Consulte o método LoadReport do objeto Viewer para um exemplo de
uso.

NOTA
O método PrintPreview do objeto Relatório de Seção não está disponível em Relatórios de Seção carregados
utilizando este método.

[Link].6 ReportFailure
ReportFailure(FailureName, FailureDescription, FailureWeight)
Este método permite que uma aplicação reporte falhas para o Servidor, que podem ser visualizadas clicando com o
botão direito do mouse no ícone do Elipse E3 na Área de Notificações do Windows. Quando este método é usado, o
ícone do Elipse E3 na Área de Notificações do Windows começa a piscar em vermelho, indicando a ocorrência de
uma falha. As falhas reportadas são normalmente condições que impedem que uma aplicação funcione parcialmente,
tais como problemas de comunicação em uma porta serial, link de rede inativo ou banco de dados sem conexão, e
que normalmente não podem ser detectadas pelo Servidor. Este método tem a finalidade de avisar o operador do
sistema a respeito de problemas em um servidor e também de auxiliar o gerenciador automático de Hot-Standby a
decidir qual servidor está mais apto para executar uma aplicação.

370 Objetos de Servidor

NOTA
Este método só está disponível no Servidor.

Este método possui os parâmetros descritos na tabela a seguir.

Parâmetros do método ReportFailure
NOME DESCRIÇÃO
FailureName Contém o nome de uma falha, definido pelo usuário. Este
mesmo parâmetro deve ser passado para o método
ClearFailure quando a aplicação detectar que a falha
não está mais ativa, como por exemplo "Falha COM1"

FailureDescription Descrição textual de uma falha, definida pelo usuário,

como por exemplo "Falha de comunicação na porta
COM1"

FailureWeight Define a severidade, ou peso, de uma falha. O valor 0

(zero) indica um aviso sem gravidade. Valores maiores
que 0 (zero) indicam falhas. Quanto maior o valor, mais
grave é a falha

O script a seguir contém um exemplo de uso deste método.

Sub TagEstadoSerial_OnValueChanged()
If Value then
' O valor do Tag é True, indica que está em falha
[Link] "FALHA_COM1", "Falha de "_
& "comunicação na porta COM1", 100
Else
' O valor do Tag é False, limpa a falha
' (indica que está OK)
[Link] "FALHA_COM1"
End If
End Sub

[Link].7 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 e com a extensão .txt. Cada nova mensagem é adicionada sempre ao
final deste arquivo. Caso haja falha no registro do arquivo, como por exemplo direito de acesso negado ou falta de
espaço em disco, ocorre um erro de script. Adicionalmente, esta mensagem é registrada no log do Elipse E3. Este
método pode ser usado, por exemplo, para registrar mensagens de depuração de scripts executados em um
servidor.
Parâmetros do método Trace
PARÂMETRO DESCRIÇÃO
MessageText Mensagem definida pelo usuário

LogTimeStamp Booleano que indica se cada registro deve ter a data e a

hora (timestamp). Este parâmetro é opcional e, se
omitido, assume o valor Verdadeiro

BreakLine Booleano que indica a presença ou não de uma quebra

de linha ao final de cada mensagem. Se este parâmetro é
configurado para Falso, força com que o arquivo tenha
todos os registros em uma só linha. Este parâmetro é
opcional e, se omitido, assume o valor Verdadeiro

Objetos de Servidor 371

[Link].8 TrackEvent
TrackEvent(EventMessage, [EventComment], [EventTimestamp])
Este método permite gerar eventos via script manualmente. Consulte o método TrackEvent do objeto Viewer para
mais informações.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Servidor (ServerApplicationE3).

NOTA
As propriedades aqui descritas só podem ser utilizadas em tempo de execução, não estando disponíveis no Elipse
E3 Studio.

[Link].1 ProductString
Esta propriedade contém uma String com o nome do produto e a versão do Servidor, como por exemplo "Elipse
E3 6.8.148" ou "Elipse E3 (64-bits) 6.8.148". Esta propriedade é somente de leitura.

[Link].2 ProductVersionBuild
Esta propriedade contém o número de build da versão do Servidor. Por exemplo, se a versão instalada é a 6.8.148,
esta propriedade contém o valor 148. Esta propriedade é somente de leitura.

[Link].3 ProductVersionMajor
Esta propriedade contém o número principal da versão do Servidor. Por exemplo, se a versão instalada é a 6.8.148,
esta propriedade contém o valor 6. Esta propriedade é somente de leitura.

[Link].4 ProductVersionMinor
Esta propriedade contém o número secundário da versão do Servidor. Por exemplo, se a versão instalada é a
6.8.148, esta propriedade contém o valor 8. Esta propriedade é somente de leitura.

5.11 Servidor de Dados

Esta seção contém informações sobre eventos, métodos e propriedades dos objetos Consulta, Consulta Hierarquia
do Aplicativo, Filtro de Alarmes, Impressora de Linha, Pasta de Dados, Tag Contador, Tag Demo, Tag Interno e
Tag Timer.

5.11.1 Consulta
Esta seção contém informações sobre eventos, métodos e propriedades do objeto Consulta (E3Query).

[Link] Eventos
Esta seção contém informações sobre os eventos do objeto Consulta (E3Query).

[Link].1 OnAsyncQueryFinish
OnAsyncQueryFinish(Recordset, Error)
Ocorre no retorno do método GetAsyncADORecordset. O parâmetro Recordset é um objeto ADO Recordset gerado
pela Consulta e o parâmetro Error é um Booleano que, quando verdadeiro, mostra que não foi possível gerar o
objeto. O script a seguir contém um exemplo de uso deste evento.
Sub Consulta1_OnAsyncQueryFinish(Recordset, Error)
MsgBox "Retornou " + CStr([Link]) + " registros"
End Sub

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Consulta (E3Query).

372 Objetos de Servidor

[Link].1 AddField
AddField(Name, [Table])
Este método 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. O script a
seguir contém um exemplo de uso deste método.
Sub Botao1_Click()
[Link]("E3Browser").Item("Consulta").AddField "Campo1"
End Sub

NOTAS
· Este método falha se a propriedade QueryType está configurada para o valor 1 - qtStorage.
· Se o parâmetro Table é omitido, o objeto Consulta tenta inserir o campo informado no parâmetro Name na
primeira tabela encontrada no banco de dados.

[Link].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. Os valores possíveis para este parâmetro são 0: Double, 1: Bit, 2: String
ou 3: Integer. Retorna um Booleano indicando o sucesso ou não da operação.

NOTA
Este método falha se a propriedade QueryType está configurada para o valor 0 - qtDBServer.

[Link].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.

NOTA
Este método falha se a propriedade QueryType está configurada para o valor 1 - qtStorage.

[Link].4 AddUaField
AddUaField(Name, [Alias], [Aggregate])
Este método adiciona, em tempo de execução, um campo a uma consulta configurada para o tipo OPC UA. Este
método retorna Verdadeiro se bem-sucedido e Falso se há falha. Os parâmetros deste método são os seguintes:
· Name: Uma String com o caminho, ou Coluna, do campo
· Alias: Uma String com o título do campo. Se este parâmetro é omitido, assume uma String vazia
· Aggregate: 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 é omitido, assume o valor Interpolative

Em uma consulta de tipo Dados Brutos, ou seja, com a propriedade UaQueryType com valor igual a 0 (zero), este
método falha se já existe um campo definido. Este método só tem efeito se a propriedade QueryType está
configurada para OPC UA, ou seja, com o valor igual a 2 - qtOpcUa. Do contrário, retorna Falso.

[Link].5 CancelAsyncADORecordset
CancelAsyncADORecordset()
Cancela todas as Consultas assíncronas criadas pelo método GetAsyncADORecordset e que são mantidas em uma
fila até que sejam executadas. Esta propriedade retorna Verdadeiro se pelo menos uma Consulta desta fila é
cancelada.

Objetos de Servidor 373

[Link].6 Execute
Execute([ImmediateExecute])
Este método executa comandos SQL que não tenham retorno, tais como DELETE, UPDATE ou INSERT, configurado na
propriedade SQL da Consulta. O parâmetro ImmediateExecute indica se a operação passa pelas filas de operações, ou
seja, arquivos .e3i e .e3o, antes de chegar ao Banco de Dados, caso esteja configurada como Falso, ou se é enviada
diretamente para o Banco de Dados, caso esteja configurada como Verdadeiro. Se este parâmetro é omitido, a
operação é enviada diretamente para o Banco de Dados. A vantagem de se utilizar a Consulta para executar
comandos é a utilização de variáveis, como em uma consulta simples. O código a seguir contém exemplos de
comandos SQL.
DELETE FROM teste WHERE cod > 10
UPDATE teste SET cod = 10 WHERE cod > 10
INSERT INTO teste(cod) VALUES(10)

O script a seguir contém um exemplo de uso deste método.

Sub CommandButton1_Click()
[Link]("Consulta1").Execute
End Sub

[Link].7 GetADORecordset
GetADORecordset()
Este método retorna um Recordset do tipo ADO (ActiveX Data Object), resultante da execução da Consulta
configurada. O script a seguir contém um exemplo de uso deste método.
Sub Botao1_Click()
Set rec = [Link]("Consulta1").GetADORecordset()
strDatas = " "
i = 0

' Mostra uma mensagem com os 10 primeiros

' registros da coluna E3TimeStamp
While (NOT [Link] AND i < 10)
strDatas = strDatas & CStr([Link]("E3TimeStamp").Value) & _
Chr(10) & Chr(13)
i = i + 1
[Link]()
Wend
MsgBox strDatas
End Sub

NOTA
Para mais informações sobre o objeto ADORecordset retornado por este método, consulte o artigo Propriedades,
Métodos e Eventos do Objeto Recordset no Microsoft Learn.

[Link].8 GetAsyncADORecordset
GetAsyncADORecordset()
Cria uma Consulta e, quando esta Consulta é finalizada, gera o evento OnAsyncQueryFinish do próprio objeto,
passando para este evento o resultado (Recordset) gerado pela Consulta.

[Link].9 GetE3QueryFields
GetE3QueryFields()
Este método retorna a Coleção de Campos ou colunas de uma Consulta. Cada item desta Coleção possui
propriedades que podem ser modificadas, conforme descrito no tópico Campo da Consulta. O script a seguir
contém um exemplo de uso deste método.
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.

Set Browser = [Link]("E3Browser")

Set Consulta = [Link]("Consulta")
Set Campos = Consulta.GetE3QueryFields()

374 Objetos de Servidor

 For Each campo In Campos
MsgBox CStr([Link]) & "-" & CStr([Link])
[Link] = True
Next
' Refaz a Consulta do E3Browser, que acabou de ser
' modificada, para que todos os campos apareçam.
Browser.RetrieveE3QueryFields()
[Link]()
End Sub

NOTA
Para usar este método, a Consulta deve ser previamente criada em tempo de configuração.

[Link].10 RemoveField
RemoveField(FieldName, [Table])
Este método remove um campo previamente incluído em uma Consulta. O parâmetro FieldName determina o nome do
campo a ser removido. O parâmetro Table determina o nome da tabela a qual o campo pertence. O script a seguir
contém um exemplo de uso deste método.
Sub CommandButton1_Click()
[Link]("E3Browser").Item("Consulta")._
RemoveField "Campo1"
End Sub

NOTA
Se o parâmetro Table é omitido, o objeto Consulta tenta remover o campo informado no parâmetro FieldName na
primeira tabela encontrada no banco de dados.

[Link].11 RemoveStorageTag
RemoveStorageTag(Name)
Remove um Tag previamente configurado na Consulta. O parâmetro Name indica o nome deste Tag. Retorna um
Booleano indicando o sucesso ou não da operação.

NOTA
Este método falha se a propriedade QueryType está configurada para o valor 0 - qtDBServer.

[Link].12 RemoveTable
RemoveTable(TableName)
Remove uma tabela da Consulta. O parâmetro TableName determina o nome da tabela a ser removida.

NOTA
Este método falha se a propriedade QueryType está configurada para o valor 1 - qtStorage.

[Link].13 RemoveUaField
RemoveUaField(Name)
Este método remove o campo com o nome especificado, se existir. O parâmetro Name é uma String com o nome ou
Coluna do campo. O método retorna Verdadeiro se bem-sucedido e Falso em caso de falha. Este método só tem
efeito se a propriedade QueryType está configurada para OPC UA (valor igual a 2 - qtOpcUa). Do contrário, retorna
Falso.

[Link].14 SetVariableValue
SetVariableValue(VarName, Value)
Este método 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 o
valor (Value), que pode ser um número, um texto ou uma data e hora. O script a seguir contém um exemplo de uso
deste método.

Objetos de Servidor 375

 Sub CommandButton_Click()
Set cons = [Link]("E3Browser1").Item("Consulta1")
DataInicial = Now - 1
DataFinal = Now
[Link] "DataIni", DataInicial
[Link] "DataFim", DataFinal
End Sub

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Consulta (E3Query).

NOTA
Não é recomendável o acesso direto destas propriedades via scripts. O ideal é acessar o objeto Consulta, passando
parâmetros através do método SetVariableValue e modificando filtros ou campos através da coleção retornada
com o método GetE3QueryFields.

[Link].1 CursorLocation
Define o local onde a Consulta é gerada e manipulada, sob o ponto de vista do SGBD (Sistema Gerenciador do
Banco de Dados). Os valores possíveis para esta propriedade são 0 - clServer: A Consulta é gerada no SGBD
(servidor) ou 1 - clClient: A Consulta é gerada no Servidor (cliente, padrão). Para mais informações, consulte também
a propriedade CursorType.

NOTA
Esta propriedade não tem efeito para Bancos de Dados em que a propriedade SourceType é igual a 0 - stAccess,
pois neste caso é sempre o Servidor que gera e manipula a Consulta. Entretanto, para SourceType igual a 1 -
stOracle ou 2 - stSqlServer, aconselha-se utilizar a opção 1 - clClient. Para mais informações, consulte a
documentação da propriedade CursorLocation e da enumeração CursorLocationEnum do objeto ADO (ActiveX Data
Object) no Microsoft Learn.

[Link].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 a propriedade CursorType
OPÇÃO DESCRIÇÃO
0 - ctKeyset Qualquer mudança nos registros inicialmente retornados
pela Consulta é visível (padrão)

1 - ctStatic Nenhuma mudança nos registros inicialmente retornados

pela Consulta é visível

2 - ctDynamic Todos os novos registros adicionados na Consulta são

visíveis, além das mudanças nos registros inicialmente
retornados pela Consulta

[Link].3 DatabaseType
Define o tipo de servidor de banco de dados usado nesta Consulta. Os valores possíveis para esta propriedade
são -1 - stUnknown: Indefinido (padrão), 0 - stAccess: Banco de dados do tipo Access, 1 - stOracle: Banco de dados
do tipo Oracle, 2 - stSqlServer: Banco de dados do tipo SQL Server, 3 - stPostgreSQL: Banco de dados do tipo
PostgreSQL ou 4 - stMySQL: Banco de dados do tipo MySQL.

[Link].4 DataSource
Indica o objeto Banco de Dados, Storage ou Driver de Comunicação OPC UA que é usado na Consulta.

[Link].5 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.

376 Objetos de Servidor

[Link].6 FunctionSubType
Especifica o subtipo da função indicada pela propriedade FunctionType. Apenas as opções 1 - ftArchivedValue, 2
- ftTagAttribute e 6 - ftCalculatedData possuem subtipos. Para as outras funções, esta propriedade assume o valor
-1 - fsNoSubType. A tabela a seguir mostra os possíveis valores desta propriedade, de acordo com a função
selecionada na propriedade FunctionType.
Subtipos para a função ArchivedValue (FunctionType igual a 1)
SUBTIPO DESCRIÇÃO
0 - fsPreviousArchivedValue Valor armazenado imediatamente anterior à estampa de
tempo fornecida

1 - fsInterpolatedArchivedValue Valor calculado a partir do valor anterior e posterior

2 - fsNextArchivedValue Valor armazenado imediatamente posterior à estampa

de tempo

3 - fsExactArchivedValue Se um valor armazenado é encontrado no exato instante

em que foi fornecido pela estampa de tempo

Subtipos para a função TagAttribute (FunctionType igual a 2)

SUBTIPO DESCRIÇÃO
0 - fsTagAttributeDescription Significado ou descrição do Tag

1 - fsTagAttributeSource Caminho do Tag que está sendo armazenado

2 - fsTagAttributeType Tipo de dados. Os valores possíveis são Double,

Boolean ou String

3 - fsTagAttributeEU Unidade de engenharia

4 - fsTagAttributeLowEng Limite inferior

5 - fsTagAttributeHighEng Limite superior

6 - fsTagAttributeDeadBand Banda morta para gravação

7 - fsTagAttributeDeadBandUnit Unidade da banda morta em valores absolutos ou

porcentagem

8 - fsTagAttributeMinRecTime Tempo mínimo para gravação. variações menores que

este intervalo são desprezadas

9 - fsTagAttributeMaxRecTime Tempo máximo para gravação. A ausência de variação

nestes intervalos força uma gravação

Subtipos para a função CalculatedData (FunctionType igual a 6)

SUBTIPO DESCRIÇÃO
0 - fsTotalCalculatedData Total dos valores

1 - fsMinimumCalculatedData Valor mínimo

2 - fsMaximumCalculatedData Valor máximo

3 - fsStandardCalculatedData Desvio padrão

4 - fsRangeCalculatedData Amplitude dos valores

5 - fsMeanCalculatedData Média dos valores

6 - fsMedianCalculatedData Mediana dos valores

[Link].7 FunctionType
Esta propriedade é válida quando um objeto Storage é fonte da Consulta, indicado pela propriedade DataSource.
Esta propriedade especifica a função que define os dados gerados pela Consulta. Algumas funções possuem

Objetos de Servidor 377

subfunções, que podem ser indicadas na propriedade FunctionSubType. Esta propriedade pode assumir os valores
descritos na tabela a seguir.
Opções disponíveis para a propriedade FunctionType
OPÇÃO DESCRIÇÃO
-1 - ftNoFunction Não há nenhuma função definida (padrão). Este valor
não está disponível quando a propriedade QueryType
está configurada para o valor 1 - qtStorage

0 - ftLastValue Retorna o último valor armazenado no banco de dados

1 - ftArchivedValue Retorna um valor armazenado em relação a um

determinado instante de tempo definido na variável
TimeStamp. O tipo de relação é definido na
propriedade FunctionSubType

2 - ftTagAttribute Devolve um atributo do Tag, definido na propriedade

FunctionSubType

3 - ftCompressedDataNValues Retorna, para um único Tag, N valores definidos na

variável NumVals, armazenados a partir de um instante
inicial definido na variável StartTime

4 - ftCompressedDataStartEndTime Retorna, para um único Tag, os valores armazenados

que estão entre o intervalo definido pelas variáveis
StartTime e EndTime

5 - ftSampledData Retorna, para um ou mais Tags, os valores interpolados,

ou seja, estimados entre os instantes definidos pelas
variáveis StartTime e EndTime, a intervalos fixos
definidos pela variável TimeInterval

6 - ftCalculatedData Retorna, para um ou mais Tags, o resultado de

operações matemáticas aplicadas aos dados entre os
instantes definidos pelas variáveis StartTime e EndTime,
a intervalos fixos definidos pela variável TimeInterval

NOTA
As variáveis também podem ser definidas em tempo de execução a partir da chamada do método SetVariableValue
da Consulta.

[Link].8 GroupBy
Texto correspondente ao argumento da cláusula GROUP BY do código SQL da Consulta.

[Link].9 Having
Texto correspondente ao argumento da cláusula HAVING do código SQL da Consulta. Esta propriedade é
normalmente utilizada com a propriedade GroupBy.

[Link].10 IgnoreQuality
Permite indicar se os dados com qualidade ruim são incluídos ou não no resultado da Consulta. Esta propriedade
só tem efeito se o objeto Consulta utiliza um objeto Storage como fonte de dados.

[Link].11 OrderBy
Texto correspondente ao argumento da cláusula ORDER BY do código SQL da Consulta.

[Link].12 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 tenta executar a consulta em um objeto Banco de Dados. Se
falhar, tenta executá-la em um objeto Storage. Este é o valor padrão para Consultas criadas no Elipse E3 Studio
ou em tempo de execução
· 0 - qtDBServer: O objeto Consulta tenta executar a consulta somente em um objeto Banco de Dados

378 Objetos de Servidor

 · 1 - qtStorage: O objeto Consulta tenta executar a consulta somente em um objeto Storage
· 2 - qtOpcUa: O objeto Consulta tenta executar a consulta somente em um objeto Driver de Comunicação OPC UA

NOTAS
· No caso de manipulação de Consultas em tempo de execução, recomenda-se configurar esta propriedade para o
tipo desejado antes de efetuar as demais configurações do objeto, especialmente no caso de reutilização de um
objeto Consulta para diferentes fontes de dados.
· Para aplicações criadas em versões anteriores, ao abrir a aplicação no Elipse E3 Studio esta propriedade é
automaticamente configurada para -1 - qtUndefined.
· Os métodos AddStorageTag e RemoveStorageTag falham se esta propriedade está configurada para 0 -
qtDBServer.
· A propriedade FunctionType não aceita o valor -1 - ftNoFunction se esta propriedade está configurada para o
valor 1 - qtStorage.
· Os métodos AddField, AddTable e RemoveTable falham se esta propriedade está configurada para o valor 1 -
qtStorage.
· Se esta propriedade está configurada para o valor -1 - qtUndefined, a tentativa de executar a Consulta em um
objeto Storage, ao falhar a Consulta em um objeto Banco de Dados, falha se a propriedade FunctionType estiver
configurada para -1 - ftNoFunction ou se a propriedade FunctionSubType está configurada para um valor
inválido.

[Link].13 SQL
Contém o código SQL especificado para a Consulta.

[Link].14 Table
Esta propriedade contém as tabelas que são consultadas. Por exemplo, Alarms é a tabela de alarmes ou eventos.
Corresponde ao argumento da cláusula FROM do código SQL da Consulta.

[Link].15 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.

[Link].16 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, padrão). No Elipse E3 Studio esta propriedade é
somente de leitura. Em tempo de execução, permite configurar o tipo da consulta OPC UA, mas só aceita escritas se a
propriedade QueryType está configurada para OPC UA (valor igual a 2 - qtOpcUa).

[Link].17 Where
Determina a condição da Consulta que filtra os registros da tabela a serem visualizados, ou seja, só são visualizados
os registros que satisfazem esta condição. Corresponde à cláusula WHERE do código SQL da Consulta.

[Link] Coleção de Campos

Esta seção contém informações sobre métodos e as propriedades do objeto Coleção de Campos da Consulta
(E3QueryCollection). Este objeto não possui eventos associados.

[Link].1 Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Campos da Consulta (E3QueryCollection).

[Link].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.

Objetos de Servidor 379

[Link].1.2 Item

Item(Index)
Retorna um objeto Campo da Consulta da Coleção de Campos. O parâmetro Index pode ser o índice numérico deste
Campo ou o nome.

[Link].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

[Link].1.4 Remove
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.

[Link].2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Campos da Consulta
(E3QueryCollection).

[Link].2.1 Count
Retorna o número de objetos Campo da Consulta nesta Coleção. Esta propriedade é somente de leitura.

[Link].3 Campo da Consulta

Esta seção contém informações sobre as propriedades do objeto propriedades do objeto Campo da Consulta
(E3QueryField). As propriedades disponíveis nesta seção são as seguintes:

[Link].3.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Campo da Consulta (E3QueryField).
Alias
Apelido do Campo na Consulta.
ColumnName
Nome da coluna. Este nome deve existir nas tabelas adicionadas nesta Consulta.
Criteria
Filtro que é aplicado sobre o Campo.
Function
Função para a qual o Campo pode ser passado como parâmetro.
GroupBy
Em Verdadeiro, indica que o Campo faz parte de um agrupamento.
OrderBy
Ordenação dos dados do Campo. Os valores válidos são "ASC" (ordenação ascendente), "DESC" (ordenação
descendente) ou uma String vazia (sem ordenação). Qualquer valor diferente significa que o Campo não possui
ordenação.
OrderNumber
Número de ordem do Campo em relação aos outros Campos que compõem a ordenação da Consulta. Este valor só
é aceito como maior que 0 (zero) se o Campo tem um tipo de ordenação, definido na propriedade OrderBy. Este
valor tem que ser menor ou igual ao número de Campos que compõem a ordenação da Consulta.

380 Objetos de Servidor

TableName
Nome da tabela a que pertence o Campo. Esta tabela deve ter sido adicionada na configuração da Consulta.
UaNodeId
Retorna um objeto do tipo Identificador de Nó OPC UA, com a configuração do Nó que identifica um campo de
uma consulta OPC UA em um determinado servidor OPC UA. No Elipse E3 Studio esta propriedade é apenas
representada por um ícone, na coluna Id da configuração de campos da Consulta. Esta propriedade é somente de
leitura.
Visible
Em Verdadeiro, indica que o Campo está visível.

[Link] Coleção de Namespaces OPC UA

Esta seção contém informações sobre métodos e propriedades do objeto Coleção de Namespaces OPC UA
(UaNamespaceArray). Este objeto não possui eventos associados.

[Link].1 Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Namespaces OPC UA (UaNamespaceArray).

[Link].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.

[Link].1.2 Item

Item(Index)
Retorna o identificador de Namespace do índice especificado. O parâmetro Index deve ser um LONG variando entre 0
(zero) e Count menos 1 (um).

[Link].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).

[Link].2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Namespaces OPC UA
(UaNamespaceArray).

[Link].2.1 Count
Retorna o número de Namespaces da coleção. O valor mínimo desta propriedade é sempre 2 (dois), já que os
índices 0 (zero) e 1 (um) estão sempre presentes. Esta propriedade é somente de leitura.

[Link].3 Identificador de Nó OPC UA

Esta seção contém informações sobre propriedades do objeto Identificador de Nó OPC UA (E3UaNodeId). Este objeto
não possui eventos nem métodos associados.

[Link].3.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Identificador de Nó OPC UA (E3UaNodeId).
GUID
Propriedade de leitura e escrita que identifica este objeto, se a propriedade Type é igual a 2 - nitGUID. Se a
propriedade Type é diferente de 2 (dois), a leitura desta propriedade retorna erro. Já a escrita nesta propriedade
força sempre com que a propriedade Type seja modificada para 2 (dois). O valor desta propriedade é uma String do
tipo GUID (Globally Unique Identifier, ou Identificador Único Global), um valor de 128 bits. Caso esta propriedade seja
configurada com o valor "{00000000-0000-0000-0000-000000000000}", este objeto é identificado como Null.

Objetos de Servidor 381

NamespaceIndex
Propriedade de leitura e escrita que identifica a qual Namespace se refere este Identificador. Este índice deve estar
entre 0 (zero) e o número de Namespaces menos 1 (um) que o servidor possuir. No caso da definição do campo na
Consulta, o índice se refere à Coleção de Namespaces OPC UA definida no objeto Consulta, que em um dado
momento pode ser diferente da Coleção de Namespaces do servidor. Este valor nunca pode ser maior que 65535,
pois o padrão OPC UA define que este é um valor de 16 bits.
Numeric
Propriedade de leitura e escrita que identifica este objeto, se a propriedade Type é igual a 0 - nitNumeric. Se a
propriedade Type é diferente de 0 (zero), a leitura desta propriedade retorna erro. Já a escrita nesta propriedade
força sempre com que a propriedade Type seja modificada para 0 (zero). Um valor 0 (zero) nesta propriedade
identifica este objeto como Null.
Opaque
Propriedade de leitura e escrita que identifica este objeto, se a propriedade Type é igual a 3 - nitOpaque. O valor
desta propriedade é um vetor de bytes, ou seja, uma String de caracteres não necessariamente válidos ou
imprimíveis. Se a propriedade Type é diferente de 3 (três), a leitura desta propriedade retorna erro. Já a escrita nesta
propriedade força sempre com que a propriedade Type seja modificada para 3 (três). Uma String vazia nesta
propriedade identifica este objeto como Null.
String
Propriedade de leitura e escrita que identifica este objeto, se a propriedade Type é igual a 1 - nitString. Se a
propriedade Type é diferente de 1 (um), a leitura desta propriedade retorna erro. Já a escrita na propriedade força
sempre com que a propriedade Type seja modificada para 1 (um). Uma String vazia nesta propriedade identifica este
objeto como Null.
Type
Propriedade de leitura e escrita que determina qual o tipo de identificador este objeto utiliza. Os valores possíveis
para esta propriedade são 0 - nitNumeric: O identificador é um número (LONG), 1 - nitString: O identificador é uma
String, 2 - nitGUID: O identificador é uma String do tipo GUID (Globally Unique Identifier) ou 3 - nitOpaque: O
identificador é um vetor de bytes. Sempre que esta propriedade é modificada, o valor do identificador é forçado para
Null.

5.11.2 Consulta Hierarquia do Aplicativo

Esta seção contém informações sobre métodos e propriedades do objeto Consulta Hierarquia do Aplicativo
(AppXQuery). Este objeto não possui eventos associados.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Consulta Hierarquia do Aplicativo (AppXQuery).

[Link].1 RunXQuery
RunXQuery([RootObjectOrPath], [pvarOutErrors])
Executa o script indicado na propriedade Script e retorna o resultado como uma String no formato XML. O
parâmetro opcional RootObjectOrPath indica um objeto ou o caminho para um objeto de início desta Consulta. Este
objeto pode ser tanto local quanto remoto, como por exemplo ao utilizar o método GetObject. Caso este parâmetro
seja omitido, este método usa o valor indicado na propriedade DefaultObjectPath. O parâmetro opcional de saída
pvarOutErrors contém uma String detalhando o resultado desta execução. Se este parâmetro é omitido e a execução
falha, este método gera um erro de script.

[Link].2 VerifyXQuery
VerifyXQuery([pVarOutErrors])
Verifica se a sintaxe do script indicado na propriedade Script está correta. Este método retorna Verdadeiro caso a
sintaxe esteja correta ou Falso caso a sintaxe esteja errada. O parâmetro opcional de saída pVarOutErrors contém uma
String detalhando o resultado desta verificação.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Consulta Hierarquia do Aplicativo (AppXQuery).

382 Objetos de Servidor

[Link].1 DefaultObjectPath
Caminho do objeto a ser usado como o objeto raiz padrão desta Consulta. Se esta propriedade não está definida,
o objeto raiz padrão é o próprio objeto Consulta Hierarquia do Aplicativo.

[Link].2 Script
Código fonte do script a ser executado por esta Consulta.

5.11.3 Filtro de Alarmes

Esta seção contém informações sobre métodos e as propriedades do objeto Filtro de Alarmes (AlarmFilter). Este
objeto não possui eventos associados.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Filtro de Alarmes (AlarmFilter).

[Link].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. O script a seguir contém um exemplo de uso deste método.
Sub CommandButton_Click()
For i = 0 To [Link]("FiltroAlarmes1").AlarmCount - 1
str = ""
set evt = [Link]("FiltroAlarmes1").GetEventByIndex(i)
str = str & "AlarmSourceName = " &_
[Link] & Chr(13)
str = str & "FullAlarmSourceName = " &_
[Link] & Chr(13)
str = str & "EventTime = " &_
[Link] & Chr(13)
str = str & "EventTimeUTC = " &_
[Link] & Chr(13)
str = str & "InTime = " &_
[Link] & Chr(13)
str = str & "OutTime = " &_
[Link] & Chr(13)
str = str & "AckTime = " &_
[Link] & Chr(13)
str = str & "CurrentValue = " &_
[Link] & Chr(13)
str = str & "ActorID = " &_
[Link] & Chr(13)
str = str & "Area = " &_
[Link] & Chr(13)
str = str & "ConditionName = " &_
[Link] & Chr(13)
str = str & "EventCategory = " &_
[Link] & Chr(13)
str = str & "EventType = " &_
[Link] & Chr(13)
str = str & "Message = " &_
[Link] & Chr(13)
str = str & "Quality = " &_
[Link] & Chr(13)
str = str & "Source = " &_
[Link] & Chr(13)
str = str & "SubConditionName = " &_
[Link] & Chr(13)
str = str & "FormattedValue = " &_
[Link] & Chr(13)
str = str & "UserField(1) = " &_
[Link](1) & Chr(13)
str = str & "UserField(2) = " &_
[Link](2) & Chr(13)
str = str & "UserField(3) = " &_
[Link](3) & Chr(13)
str = str & "UserField(4) = " &_
Objetos de Servidor 383
 [Link](4) & Chr(13)
str = str & "Severity = " &_
[Link] & Chr(13)
str = str & "Acked = " &_
[Link] & Chr(13)
str = str & "AckRequired = " &_
[Link] & Chr(13)
str = str & "ConditionActive = " &_
[Link] & Chr(13)
str = str & "Enabled = " &_
[Link] & Chr(13)
str = str & "EventCLSID = " &_
[Link] & Chr(13)
MsgBox str
Next
End Sub

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Filtro de Alarmes (AlarmFilter).

[Link].1 ActiveAlarms
Determina o número de alarmes ativos em um Filtro de Alarmes. Esta propriedade é somente de leitura.

[Link].2 ActiveCritAlarms
Indica o número de alarmes ativos com severidade Crítica em um Filtro de Alarmes. Esta propriedade é somente de
leitura.

[Link].3 ActiveCritNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Crítica em um Filtro de Alarmes. Esta propriedade é
somente de leitura.

[Link].4 ActiveHighAlarms
Indica o número de alarmes ativos com severidade Alta em um Filtro de Alarmes. Esta propriedade é somente de
leitura.

[Link].5 ActiveHighNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Alta em um Filtro de Alarmes. Esta propriedade é
somente de leitura.

[Link].6 ActiveLowAlarms
Indica o número de alarmes ativos com severidade Baixa em um Filtro de Alarmes. Esta propriedade é somente de
leitura.

[Link].7 ActiveLowNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Baixa em um Filtro de Alarmes. Esta propriedade é
somente de leitura.

[Link].8 ActiveMedAlarms
Indica o número de alarmes ativos com severidade Média em um Filtro de Alarmes. Esta propriedade é somente de
leitura.

[Link].9 ActiveMedNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Média em um Filtro de Alarmes. Esta propriedade é
somente de leitura.

[Link].10 ActiveNACKAlarms
Indica o número de alarmes que estão sem reconhecimento em um Filtro de Alarmes. Esta propriedade é somente
de leitura.

384 Objetos de Servidor

[Link].11 AlarmCount
Determina o número de alarmes em um Filtro de Alarmes. Esta propriedade é somente de leitura.

[Link].12 AlarmServer
Nome do Servidor de Alarmes único existente em uma aplicação.

[Link].13 AreaFilter
Controla as Áreas de alarmes visíveis no Filtro de Alarmes. Se o valor não é uma String vazia, são apresentados
eventos cujo nome das Áreas comecem com o texto indicado. Por exemplo, se esta propriedade é igual a "Ana", são
mostrados os alarmes de Áreas como "[Link]" ou "Analise", mas não "[Link]" ou
"[Link]". Quando a propriedade SimpleAreaFilter está configurada como Falso, a Área de Alarme também
permite o uso de caracteres curinga para a filtragem e múltiplos filtros de Área, separados por dois pontos. Os
caracteres curinga 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 valor padrão desta propriedade é uma String vazia, ou seja, sem filtragem por Área. Consulte também as
propriedades CustomFilter, SimpleAreaFilter, ShowCriticalPriority, ShowHighPriority, ShowMediumPriority e
ShowLowPriority.

[Link].14 Connections
Retorna uma coleção de Conexões em um Filtro de Alarmes. Esta propriedade é somente de leitura. Para mais
informações sobre a coleção retornada nesta propriedade, consulte o tópico Coleção de Conexões.

[Link].15 CustomFilter
Permite informar um filtro personalizado para os alarmes, na forma de uma expressão. A tabela a seguir contém os
campos disponíveis para utilização na expressão deste filtro.
Campos disponíveis para a propriedade CustomFilter
CAMPO TIPO DE DADOS DESCRIÇÃO
Acked Booleano Indica se a mensagem já foi
reconhecida

AckRequired Booleano Indica se é necessário reconhecer a

mensagem

AckTime Data e Hora Data e hora em que a condição de

alarme foi reconhecida ou 0 (zero) se
ainda não foi reconhecida

ActiveSource Inteiro Fonte de medida ativa. Os valores

possíveis são -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

Objetos de Servidor 385

 CAMPO TIPO DE DADOS DESCRIÇÃO
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,

sem o caminho completo

AllowShelving Booleano Indica se o alarme pode ser

arquivado

Area String Área deste alarme

ChangeMask Inteiro Campo não utilizado pelo Elipse E3

atualmente, 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 se torna ativa

Deleted Booleano Indica se o alarme foi removido

Enabled Booleano Indica se a verificação de alarmes na

Fonte de Alarme está habilitada

EventCLSID String Identificador único para toda a vida

de um alarme

EventCategory String Nome da categoria do alarme, como

por exemplo "Nível", "Taxa de
Variação", "Banda Morta", "Digital" ou
"Discreto"

EventTime Data e Hora Data e hora da última atualização do

evento

EventTimeUTC Data e Hora Data e hora da última atualização do

evento, no formato UTC

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 se torna ativa

FullAlarmSourceName String Nome completo do objeto Fonte de

Alarme

InTime Data e Hora Data e hora em que a condição de

alarme se torna ativa

Message String Mensagem do alarme

OutTime Data e Hora Data e hora em que a condição saiu

de alarme ou 0 (zero) se ainda está
ativa

Quality String Qualidade, como por exemplo "Boa

(xxx)", "Ruim (xxx)" ou "Incerta (xxx)"

Severity Inteiro Severidade do alarme. Os valores

possíveis são -2: Crítica, 0: Alta, 1:
Média ou 2: Baixa

386 Objetos de Servidor

 CAMPO TIPO DE DADOS DESCRIÇÃO
ShelveActorID String Login do usuário que arquivou o
alarme

ShelveCount Word Número de vezes que o evento foi

arquivado

Shelved Booleano Indica se o evento foi arquivado

ShelvedOutTime Data e Hora Data e hora em que este evento foi

desarquivado

ShelvedTime Data e Hora Data e hora em que este evento foi

arquivado

ShelveDuration Double Word Tempo, em minutos, que este evento

esteve arquivado

ShelveMaxCount Word Número máximo de vezes que este

evento pode ser arquivado

ShelveMaxDuration Double Word Tempo máximo, em minutos, que este

evento pode permanecer arquivado

ShelveReason String Motivo pelo qual este evento foi

arquivado

Source String Associação da Fonte de Alarme

SubConditionName String Nome da subcondição de alarme,

como por exemplo "LOLO", "LO", "HI",
"HIHI" ou "DIG"

Unbound Booleano Indica se o alarme está vinculado a

uma Fonte de Alarme

UserFieldArray Variant Campos definidos pelo usuário. Use

diretamente o nome do campo na
expressão, como por exemplo
"CampoUsuario1 = 123"

Ao todo, as mensagens que aparecem na listagem do Filtro de Alarmes sempre passam por estes filtros:
· Filtro por tipo, definido na propriedade FilterType
· Filtro por severidade, definida nas propriedades ShowCriticalPriority, ShowLowPriority, ShowMediumPriority e
ShowHighPriority
· Filtro por área, definida nas propriedades AreaFilter e SimpleAreaFilter
· Filtro por esta propriedade
· Filtro do sumário de alarmes, equivalente à expressão "Enabled AND (ConditionActive OR (AckRequired AND NOT
Acked))"

Para exemplos de uso desta propriedade, consulte a propriedade CustomFilter do objeto E3Alarm.

[Link].16 Events
Retorna uma coleção de Eventos em um Filtro de Alarmes. Esta propriedade é somente de leitura. Para mais
informações sobre a coleção retornada nesta propriedade, consulte o tópico Coleção de Eventos. O script a seguir
contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
For Each evt In [Link]("FiltroAlarmes1").Events
str = ""
str = str & "AlarmSourceName = " &_
[Link] & Chr(13)
str = str & "FullAlarmSourceName = " &_
[Link] & Chr(13)
str = str & "EventTime = " &_
[Link] & Chr(13)
str = str & "EventTimeUTC = " &_
[Link] & Chr(13)
Objetos de Servidor 387
 str = str & "InTime = " &_
[Link] & Chr(13)
str = str & "OutTime = " &_
[Link] & Chr(13)
str = str & "AckTime = " &_
[Link] & Chr(13)
str = str & "CurrentValue = " &_
[Link] & Chr(13)
str = str & "ActorID = " &_
[Link] & Chr(13)
str = str & "Area = " &_
[Link] & Chr(13)
str = str & "ConditionName = " &_
[Link] & Chr(13)
str = str & "EventCategory = " &_
[Link] & Chr(13)
str = str & "EventType = " &_
[Link] & Chr(13)
str = str & "Message = " &_
[Link] & Chr(13)
str = str & "Quality = " &_
[Link] & Chr(13)
str = str & "Source = " &_
[Link] & Chr(13)
str = str & "SubConditionName = " &_
[Link] & Chr(13)
str = str & "FormattedValue = " &_
[Link] & Chr(13)
str = str & "UserField(1) = " &_
[Link](1) & Chr(13)
str = str & "UserField(2) = " &_
[Link](2) & Chr(13)
str = str & "UserField(3) = " &_
[Link](3) & Chr(13)
str = str & "UserField(4) = " &_
[Link](4) & Chr(13)
str = str & "Severity = " &_
[Link] & Chr(13)
str = str & "Acked = " &_
[Link] & Chr(13)
str = str & "AckRequired = " &_
[Link] & Chr(13)
str = str & "ConditionActive = " &_
[Link] & Chr(13)
str = str & "Enabled = " &_
[Link] & Chr(13)
str = str & "EventCLSID = " &_
[Link] & Chr(13)
MsgBox str
Next
End Sub

[Link].17 Filters
Retorna uma coleção de Filtros em um Filtro de Alarmes. Esta propriedade é somente de leitura. Para mais
informações sobre a coleção retornada nesta propriedade, consulte o tópico Coleção de Filtros.

[Link].18 FilterType
Efetua os filtros de alarme. Os valores possíveis para esta propriedade são 1 - OnlyAlarms: Mostra apenas
alarmes (padrão), 2 - OnlyEvents: Mostra apenas eventos ou 3 - AlarmsAndEvents: Mostra tanto alarmes quanto
eventos.

[Link].19 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.

[Link].20 FourthSortField
Determina o campo quaternário para a ordenação dos eventos em um Filtro de Alarmes. O nome do campo deve
ser sempre especificado em inglês. Consulte os campos disponíveis no Manual do Usuário do Elipse E3. O valor

388 Objetos de Servidor

padrão desta propriedade é uma String vazia. Esta propriedade não tem efeito quando as propriedades
PrimarySortField, SecondarySortField ou ThirdSortField são configuradas como uma String vazia.

[Link].21 InactiveCritNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Crítica em um Filtro de Alarmes. Esta
propriedade é somente de leitura.

[Link].22 InactiveHighNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Alta em um Filtro de Alarmes. Esta
propriedade é somente de leitura.

[Link].23 InactiveLowNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Baixa em um Filtro de Alarmes. Esta
propriedade é somente de leitura.

[Link].24 InactiveMedNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Média em um Filtro de Alarmes. Esta
propriedade é somente de leitura.

[Link].25 InactiveNACKAlarms
Determina o número total de alarmes inativos e não reconhecidos em um Filtro de Alarmes. Esta propriedade é
somente de leitura.

[Link].26 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.

[Link].27 PrimarySortField
Determina o campo primário para a ordenação dos eventos em um Filtro de Alarmes. O nome do campo deve ser
sempre especificado em inglês. Consulte os campos disponíveis no Manual do Usuário do Elipse E3. O valor padrão
desta propriedade é "EventTime". Quando esta propriedade é uma String vazia, as propriedades SecondarySortField,
ThirdSortField e FourthSortField não têm efeito.

[Link].28 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.

[Link].29 SecondarySortField
Determina o campo secundário para a ordenação dos eventos em um Filtro de Alarmes. O nome do campo deve
ser sempre especificado em inglês. Consulte os campos disponíveis no Manual do Usuário do Elipse E3. O valor
padrão desta propriedade é uma String vazia. Esta propriedade não tem efeito quando a propriedade
PrimarySortField é configurada como uma String vazia.

[Link].30 ShowCriticalPriority
Se esta propriedade está configurada para Verdadeiro, mostra os alarmes com severidade Crítica. O valor padrão
desta propriedade é Verdadeiro.

[Link].31 ShowHighPriority
Se esta propriedade está configurada para Verdadeiro, mostra os alarmes com severidade Alta. O valor padrão
desta propriedade é Verdadeiro.

[Link].32 ShowLowPriority
Se esta propriedade está configurada para Verdadeiro, mostra os alarmes com severidade Baixa. O valor padrão
desta propriedade é Verdadeiro.

Objetos de Servidor 389

[Link].33 ShowMediumPriority
Se esta propriedade está configurada para Verdadeiro, mostra os alarmes com severidade Média. O valor padrão
desta propriedade é Verdadeiro.

[Link].34 SimpleAreaFilter
Quando esta propriedade é igual a Verdadeiro, o comportamento de filtragem pelo nome de uma Área de Alarmes
é baseado apenas na coincidência da parte inicial do nome. Quando é igual a Falso, o comportamento leva em conta
todo o nome da Área, mas permite o uso de caracteres curinga e múltiplos filtros de Área, que devem ser separados
por dois pontos. Consulte também a propriedade AreaFilter, que especifica o filtro por nome de Área.

[Link].35 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.

[Link].36 ThirdSortField
Determina o campo terciário para a ordenação dos eventos em um Filtro de Alarmes. O nome do campo deve ser
sempre especificado em inglês. Consulte os campos disponíveis no Manual do Usuário do Elipse E3. O valor padrão
desta propriedade é uma String vazia. Esta propriedade não tem efeito quando as propriedades PrimarySortField
ou SecondarySortField são configuradas como uma String vazia.

5.11.4 Impressora de Linha

Esta seção contém informações sobre métodos e as propriedades do objeto Impressora de Linha (LinePrinter). Este
objeto não possui eventos associados.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Impressora de Linha (LinePrinter).

[Link].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) Caractere de retorno de carro

vbLf Chr(10) Caractere de nova linha

vbCrLf Chr(13) & Chr(10) Caracteres de retorno de carro e

nova linha

vbNewLine Chr(13) & Chr(10) ou Chr(10) Caracteres de retorno de carro e

nova linha ou somente o caractere de
nova linha, dependendo da
impressora utilizada

vbTab Chr(9) Caractere de tabulação

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Impressora de Linha (LinePrinter).

390 Objetos de Servidor

[Link].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.

[Link].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
· Caso esta propriedade esteja configurada com uma String vazia e a propriedade UseDefaultPrinter esteja
configurada para Falso, não é possível imprimir e a propriedade PrinterStatus retorna o valor 0 (zero,
psUnknown).
· A impressora padrão do Windows para o usuário atualmente logado pode ser diferente da impressora padrão
utilizada pelo E3 Server. Esta impressora está identificada pelo ícone na janela E3 Admin - Impressora. Para
isto, clique com o botão direito do mouse no ícone do E3 Admin na Área de Notificações do Windows e selecione
a opção Impressora.

[Link].3 PrinterStatus
Indica o status da impressora selecionada para o objeto Impressora de Linha. Esta propriedade é somente de
leitura. Os valores possíveis para esta propriedade são 0 - psUnknown: Status desconhecido (padrão), 1 - psOffline:
A impressora não está disponível, 2 - psError: Houve um erro na impressão ou 3 - psReady: A impressora está pronta
para impressão.

[Link].4 UseDefaultPrinter
Configura o objeto Impressora de Linha para utilizar a impressora padrão do Windows. O valor padrão desta
propriedade é Verdadeiro.

NOTAS
· Caso esta propriedade esteja configurada para Falso e a propriedade PrinterName esteja configurada com uma
String vazia, não é possível imprimir e a propriedade PrinterStatus retorna o valor 0 (zero, psUnknown).
· A impressora padrão do Windows para o usuário atualmente logado pode ser diferente da impressora padrão
utilizada pelo E3 Server. Esta impressora está identificada pelo ícone na janela E3 Admin - Impressora. Para
isto, clique com o botão direito do mouse no ícone do E3 Admin na Área de Notificações do Windows e selecione
a opção Impressora.

5.11.5 Pasta de Dados

O objeto Pasta de Dados não possui eventos, métodos ou propriedades específicos associados, somente métodos e
propriedades gerais. Estes podem ser visualizados nas seções Eventos, Métodos e Propriedades Gerais dos
Objetos.

5.11.6 Tag Contador

Esta seção contém informações sobre eventos e propriedades do objeto Tag Contador (CounterTag). Este objeto não
possui métodos associados.

[Link] Eventos
Esta seção contém informações sobre os eventos do objeto Tag Contador (CounterTag).

[Link].1 OnPreset
OnPreset()
Ocorre toda vez que o valor da propriedade Preset é alcançado.

Objetos de Servidor 391

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Tag Contador (CounterTag).

[Link].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 quando a propriedade CounterType está configurada com o valor 0 -
Preset.

[Link].2 CounterType
Define o comportamento do contador. Os valores possíveis para esta propriedade são 0 - Preset: A contagem é
interrompida quando o valor estabelecido na propriedade Preset é atingido (padrão) ou 1 - Infinite: A contagem
prossegue indefinidamente.

[Link].3 Enabled
Inicia ou para o contador. Em Verdadeiro, a contagem é iniciada. Em Falso, a contagem é interrompida.

[Link].4 Increment
Define o intervalo de atualização da propriedade Value. Caso esta propriedade tenha o valor modificado enquanto
a contagem está em curso, esta modificação só tem efeito quando o contador é parado e reiniciado.

[Link].5 Preset
Limite a ser atingido pelo contador, em segundos. Caso o valor desta propriedade não seja um múltiplo do valor da
propriedade Increment, o Tag atinge este valor antes do próximo incremento.

[Link].6 ResetCounterWhenEnabled
Habilita o reinício da contagem (do zero) cada vez que o valor da propriedade Enabled retorna a Verdadeiro.
Quando desabilitada, o contador reinicia a contagem de onde foi interrompida anteriormente.

[Link].7 Value
Mostra a contagem do contador, em segundos. Esta propriedade é somente de leitura. Esta propriedade recebe
valores múltiplos do valor da propriedade Increment, exceto quando a propriedade Enabled é ajustada para Falso.
Neste caso, o valor é o do momento em que o Tag foi desabilitado. Ao reiniciar a contagem, o valor da propriedade
é o próximo múltiplo do valor da propriedade Increment. O valor máximo desta propriedade é 2147483647
(0x7FFFFFFF).

5.11.7 Tag Demo

Esta seção contém informações sobre métodos e propriedades do objeto Tag Demo (DemoTag). Este objeto não
possui eventos associados.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Tag Demo (DemoTag).

[Link].1 Reset
Reset()
Zera a fase, ou deslocamento em tempo, da forma de onda de um Tag Demo. A fase da onda somente é zerada
quando um Tag Demo está habilitado. Este método, quando um Tag Demo está habilitado, não tem efeito nos Tags
Demo do tipo CurrentTime e Random, que não são periódicos. Quando um Tag Demo está desabilitado, o valor é
simplesmente zerado, independentemente do tipo de Tag Demo.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Tag Demo (DemoTag).

392 Objetos de Servidor

[Link].1 Enabled
Esta propriedade habilita ou desabilita a variação de um Tag Demo. Se esta propriedade está configurada para
Falso, a variação está desabilitada. Caso contrário, um Tag Demo atualiza a propriedade Value conforme a
configuração das propriedades Period e Scan. O valor padrão desta propriedade é Verdadeiro.

[Link].2 Maximum
Esta propriedade determina o valor máximo de um Tag Demo. O valor padrão desta propriedade é 100.

[Link].3 Minimum
Esta propriedade determina o valor mínimo de um Tag Demo. O valor padrão desta propriedade é 0 (zero).

[Link].4 Period
Define o comprimento da forma de onda, em milissegundos. Não se aplica quando a propriedade Type está
configurada para 0 - Random ou 3 - CurrentTime. O valor padrão desta propriedade é 10000 ms.

[Link].5 Scan
Esta propriedade define o intervalo de tempo, em milissegundos, entre duas variações da propriedade Value. Utilize
esta propriedade se o usuário desejar maior ou menor quantidade de dados gerados por um Tag Demo. O valor
padrão desta propriedade é 1000. O valor do scan deve ser maior que 0 (zero).

[Link].6 TimeStamp
Esta propriedade é atualizada sempre que ocorrer alguma mudança de valor ou estado nas propriedades Value
ou Quality. Informa qual a data e hora associada tanto ao valor quanto à qualidade de um Tag Demo. Esta
propriedade é somente de leitura. O valor padrão desta propriedade é 00:00:00.

[Link].7 Type
Determina o tipo da forma de onda de um Tag Demo. Modifique a propriedade conforme a tabela a seguir.
Quando esta propriedade está configurado para 3 (três, CurrentTime), a propriedade Value contém a data e hora
atual do servidor.
Opções disponíveis para a propriedade Type
VALOR FORMA DE ONDA
0 Random (aleatória)

1 Sine (onda senoide, padrão)

2 Square (onda quadrada)

3 CurrentTime (data e hora)

4 RampUp (borda de subida)

5 RampDown (borda de descida)

6 RampUpDown (borda de subida e descida)

[Link].8 Value
Esta propriedade varia de acordo com o tipo da forma de onda de um Tag Demo, estabelecida na propriedade
Type. Esta propriedade é somente de leitura.

NOTA
Quando a propriedade Type é igual a 3 (três, CurrentTime), o tipo de dados desta propriedade é Date. Neste caso,
o valor padrão é a data e hora atual do servidor. Em todos os outros casos, o tipo de dados desta propriedade é
Double. Nestes casos, o valor padrão é 0 (zero).

Objetos de Servidor 393

5.11.8 Tag Interno
Esta seção contém informações sobre métodos e propriedades do objeto Tag Interno (InternalTag). Este objeto não
possui eventos associados.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Tag Interno (InternalTag).

[Link].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 omitido, assume a qualidade Boa (192). O
script a seguir contém um exemplo de uso deste método.
Sub CommandButton12_Click()
Dim Ret
Ret = [Link]("Dados.TagInterno1")._
WriteEx(123.456, "1/1/2001", 193)
If Ret Then
MsgBox "Funcionou!"
Else
MsgBox "Falhou!"
End If
End Sub

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Tag Interno (InternalTag).

[Link].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 é modificado, seja por script ou por uma Associação, esta propriedade é atualizada de
acordo.

NOTA
Para mais informações sobre qualidade, consulte o tópico Qualidade no Manual do Usuário do Elipse E3.

[Link].2 Retentive
Esta propriedade determina se o valor do Tag Interno deve ser armazenado automaticamente ou não, caso o
Domínio seja parado. Isto garante que o valor do Tag é sincronizado com um servidor em standby. Assim, quando o
servidor é 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 é executado ou se ocorrer troca do servidor ativo. Esta propriedade não
pode ser alterada com o objeto ativo. O script a seguir contém um exemplo de uso desta propriedade.
Sub CommandButton1_Click()
Dim status
status = [Link]("Dados.TagInterno1").Retentive
MsgBox status
Select Case status
Case True
MsgBox "O valor do Tag Interno é _
armazenado automaticamente."
Case False
MsgBox "O valor do Tag Interno é ajustado para o valor _
inicial sempre que o Domínio é executado ou _
se ocorrer troca do servidor ativo."
End Select
End Sub

394 Objetos de Servidor

NOTA
Esta propriedade só é válida para Tags Internos contidos no Servidor. Tags Internos contidos no Viewer não podem
ser retentivos.

[Link].3 TimeStamp
Esta propriedade informa a data e hora associada ao valor contido na propriedade Value. Esta propriedade é de
leitura e escrita, mas sempre que o valor do Tag Interno é modificado, seja por script ou por uma Associação, esta
propriedade é atualizada de acordo.

[Link].4 Value
Esta propriedade é do tipo Variant, o que permite armazenar valores de todo e qualquer tipo, desde um inteiro até
referências para objetos, conforme o exemplo a seguir. Utilize-a para guardar valores dentro do Viewer ou Servidor e
para trocar dados entre os diversos pontos de uma aplicação. O valor padrão desta propriedade é vazio. Esta
propriedade é de leitura e escrita. O script a seguir contém um exemplo de uso desta propriedade.
Sub Meses_OnStartRunning()
' Meses é um Tag do tipo InternalTag.
' Utiliza-se o evento para inicializar o vetor.
Value = Array("Janeiro", "Fevereiro", "Março", _
"Abril", "Maio", "Junho", "Julho", "Agosto", _
"Setembro", "Outubro", "Novembro", "Dezembro")
End Sub

5.11.9 Tag Timer

Esta seção contém informações sobre eventos e propriedades do objeto Tag Timer (TimerTag). Este objeto não
possui eventos associados.

[Link] Eventos
Esta seção contém informações sobre os eventos do objeto Tag Timer (TimerTag).

[Link].1 OnPreset
OnPreset()
Ocorre toda vez que o valor da propriedade NextExecTime é alcançado.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Tag Timer (TimerTag).

[Link].1 Enabled
Habilita ou desabilita o Timer. O valor padrão desta propriedade é Verdadeiro.

[Link].2 NextExecTime
Exibe o próximo horário de disparo. Esta propriedade é somente de leitura.

[Link].3 RepeatInterval
Esta propriedade indica um intervalo de tempo para a repetição de uma ação. Esta propriedade só está disponível
se a propriedade TriggerType está configurada para o valor 1 - ttContinuous. Os valores possíveis para esta
propriedades estão no intervalo entre 00:00:01 (um segundo, valor padrão) e 23:59:59.

[Link].4 StartTime
Data e hora inicial do Timer. Para a propriedade TriggerType com o valor 0 - ttSingle, é a própria data e hora de
disparo. Para os demais valores, é o momento a partir do qual o Timer começa a disparar. O valor padrão desta
propriedade é o dia e a hora locais.

[Link].5 TriggerType
Tipo de disparo do Timer. As opções disponíveis estão descritas na tabela a seguir.

Objetos de Servidor 395

 Opções disponíveis para a propriedade TriggerType
OPÇÃO DESCRIÇÃO
0 - ttSingle Disparo único

1 - ttContinuous Disparo contínuo (padrão)

2 - ttDaily Disparo diário

3 - ttMonthly Disparo mensal

5.12 Storage
Esta seção contém informações sobre métodos e propriedades do objeto Storage (Historian). Este objeto não possui
eventos associados.

5.12.1 Métodos
Esta seção contém informações sobre os métodos do objeto Storage (Historian).

[Link] 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 na criação. São os
seguintes:
· DefaultType: Tipo de dados (0: Double, 1: Bit, 2: String ou 3: Integer). Se este parâmetro é omitido, utiliza o
valor 0: Double
· DefaultMinRecTime: Intervalo mínimo de tempo entre gravações. Se este parâmetro é omitido, utiliza o valor 0
(zero)
· DefaultMaxRecTime: Intervalo máximo de tempo sem gravações. Se este parâmetro é omitido, utiliza o valor
3600
· DefaultDeadBand: Banda morta. Se este parâmetro é omitido, utiliza o valor 1 (um)
· DefaultDeadBandUnit: Unidade da banda morta do Tag (0: Porcentagem ou 1: Absoluta). Se este parâmetro é
omitido, utiliza o valor 1: Absoluta
· DefaultScanTime: Tempo de varredura. Se este parâmetro é omitido, utiliza o valor 0 (zero)

Este método funciona mesmo que o objeto Storage não tenha nenhum Campo configurado.

[Link] 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. O script a seguir contém um exemplo de uso deste método.
Sub Botao1_Click()
' Ao clicar neste botão, habilita o Storage
[Link]("Storage1").StartAcquisition()
End Sub

[Link] 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. O script a
seguir contém um exemplo de uso deste método.
Sub Storage1_OnStartRunning()
' Desabilita o Storage após iniciar
StopAcquisition()
End Sub

396 Objetos de Servidor

5.12.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Storage (Historian).

[Link] BackupDiscardInterval
Indica o intervalo máximo de tempo (minutos, horas, dias ou meses) dos dados na tabela de backup do Storage 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).

NOTA
O tempo total indicado pela combinação desta propriedade e da propriedade BackupDiscardTimeUnit deve ser
maior que o tempo indicado pelas propriedades DiscardInterval e DiscardTimeUnit.

[Link] BackupDiscardTimeUnit
Esta propriedade indica a unidade de tempo em que os dados de backup do Storage permanecem armazenados,
até serem descartados. As opções disponíveis são 0 - dtHour: Horas, 1 - dtDay: Dias, 2 - dtMonth: Meses (padrão)
ou 3 - dtMinute: Minutos. Esta propriedade trabalha em conjunto com a propriedade BackupDiscardInterval.

[Link] 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 esta propriedade é 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.

NOTA
O bloco de registros é enviado a cada um segundo, mesmo que não se tenha atingido o tamanho configurado nesta
propriedade.

[Link] CompressionRate
Mostra a taxa de compressão de dados obtida até o momento. Esta propriedade é somente de leitura.

[Link] 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.

[Link] DiscardInterval
Esta propriedade trabalha em conjunto com a propriedade DiscardTimeUnit e indica o intervalo de tempo durante
o qual os dados do Storage 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 é
configurada com um valor menor ou igual ao valor da propriedade BackupDiscardInterval, o Elipse E3
automaticamente ajusta o valor de BackupDiscardInterval com o dobro do valor desta propriedade.

[Link] DiscardTimeUnit
Esta propriedade trabalha em conjunto com a propriedade DiscardInterval e indica a unidade de tempo em que
os dados do Storage permanecem armazenados até serem descartados. As opções disponíveis são 0 - dtHour:
Horas, 1 - dtDay: Dias, 2 - dtMonth: Meses (padrão) ou 3 - dtMinute: Minutos.

[Link] EnableBackupTable
Cria uma tabela de backup onde os dados descartados do Storage 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.

Objetos de Servidor 397

[Link] EnableDiscard
Habilita o descarte dos dados do Storage 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.

[Link] Fields
Esta propriedade retorna um objeto que representa a coleção de Campos criados em um Storage e é somente de
leitura. Para mais informações sobre o objeto retornado nesta propriedade, consulte o tópico Fields.

NOTAS
· Em aplicações criadas antes da versão 5.0 do Elipse E3, esta propriedade é uma coleção que suporta o método
Item para acessar os Campos disponíveis. A partir da versão 5.0, esta propriedade também retorna um objeto e,
portanto, a forma de acesso aos Campos é diferente para ambas as formas. O exemplo a seguir demonstra a
forma correta de utilização desta propriedade.
· Aplicações salvas na versão 5.0 convertem os objetos Storage do formato de coleção para objeto e NÃO podem
mais ser abertas em versões anteriores.

Para acessar a coleção de Campos do Storage tanto como uma coleção quanto como um objeto, use a sintaxe
descrita no exemplo a seguir.
'A aplicação contém um objeto chamado Storage1
'que contém um Campo chamado Campo1.
'Para acessar este Campo a partir de uma coleção,
'use a seguinte sintaxe:
Set campoColecao = [Link]("Storage1").[Link]("Campo1")
'Para acessar este mesmo Campo como um objeto,
'use a seguinte sintaxe:
Set campoNativo = [Link]("[Link].Campo1")

[Link] StringFieldSize
Esta propriedade especifica o tamanho máximo que os Campos do tipo String do objeto Storage podem ter, que é
o tamanho utilizado na criação do campo Value da tabela de Strings.

[Link] TableName
Define o nome da tabela que é utilizada no Storage.

[Link] VerificationInterval
Esta propriedade trabalha em conjunto com a propriedade VerificationUnit para controlar o intervalo de tempo
que o Elipse E3 verifica a antiguidade dos dados do Storage, para depois descartá-los. O valor padrão desta
propriedade é 1 (uma unidade de tempo indicada na propriedade VerificationUnit).

[Link] VerificationUnit
Esta propriedade trabalha em conjunto com a propriedade VerificationInterval e indica a unidade de tempo em
que é realizada a verificação para descarte dos dados do Storage. As opções disponíveis são 0 - dtHour: Horas, 1 -
dtDay: Dias, 2 - dtMonth: Meses (padrão) ou 3 - dtMinute: Minutos.

5.12.3 Fields
Esta seção contém informações sobre métodos e propriedades do objeto Fields (IStorageFieldsCollection). Este
objeto não possui eventos associados.

NOTA
O objeto Fields pode ser acessado através da propriedade Fields do Storage.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Fields (IStorageFieldsCollection).

398 Objetos de Servidor

[Link].1 AddField
AddField(FieldLink, [FieldName], [FieldType], [FieldMinRecTime], [FieldMaxRecTime],
[FieldScanTime], [FieldDeadBand], [FieldDeadBandUnit])
Este método adiciona um objeto Campo do Storage no objeto Fields. Os parâmetros deste método estão descritos
na tabela a seguir.
Parâmetros do método AddField
PARÂMETRO DESCRIÇÃO
FieldLink Fonte de dados associada a este Campo do Storage.
Este parâmetro é obrigatório e corresponde à
propriedade Link do Campo do Storage

FieldName Nome do Campo do Storage no objeto Fields. Este

parâmetro é opcional e, se omitido, recebe a expressão
"Campo". Este parâmetro corresponde à propriedade
Name do Campo do Storage. Consulte a propriedade
geral Name para mais informações sobre os caracteres
permitidos nos nomes de objetos

FieldType Tipo de dados do Campo do Storage. Os valores

possíveis para este parâmetro são 0: eStorageDouble, 1:
eStorageBit, 2: eStorageText ou 3: eStorageInteger. Este
parâmetro é opcional e, se omitido, utiliza o valor 0
(zero). Este parâmetro corresponde à propriedade Type
do Campo do Storage

FieldMinRecTime Tempo mínimo, em milissegundos, para que um novo

dado seja gravado. Este parâmetro é opcional e, se
omitido, este tempo é configurado em 0 (zero), ou seja,
desabilita o tempo mínimo. Este parâmetro corresponde
à propriedade MinRecTime do Campo do Storage

FieldMaxRecTime Tempo máximo, em segundos, sem que nenhum dado

seja gravado. Este parâmetro é opcional e, se omitido,
este tempo é configurado com o valor 3600 (uma hora).
Este parâmetro corresponde à propriedade
MaxRecTime do Campo do Storage

FieldScanTime Indica de quanto em quanto tempo, em milissegundos, o

valor do Tag é realimentado no algoritmo de
compactação de dados, caso não esteja variando. Este
parâmetro é opcional e, se omitido, utiliza o valor
configurado no parâmetro FieldMaxRecTime. Este
parâmetro corresponde à propriedade ScanTime do
Campo do Storage

FieldDeadBand Banda morta utilizada para cálculo do algoritmo do

Storage. Este parâmetro é opcional e, se omitido, utiliza
o valor 1 (um). Este parâmetro corresponde à
propriedade DeadBand do Campo do Storage

FieldDeadBandUnit Unidade de banda morta do parâmetro FieldDeadBand

como um percentual de banda morta (0: dbPercent) ou
em unidades absolutas (1: dbAbsolute). Este parâmetro é
opcional e, se omitido, utiliza o valor 0 (zero, percentual).
Este parâmetro corresponde à propriedade
DeadBandUnit do Campo do Storage

[Link].2 DeleteField
DeleteField(Index)

Objetos de Servidor 399

Remove o Campo do Storage informado no parâmetro Index, que pode ser a posição do Campo do Storage
(iniciando em um) ou o valor da propriedade Name do Campo do Storage, se este Campo do Storage existir no
objeto Fields. Caso contrário, este método retorna um erro de script.

[Link].3 RemoveAll
RemoveAll()
Este método remove todos os objetos Campo do Storage do objeto Fields.

[Link] Propriedades
Esta seção contém informações sobre as propriedades do objeto Fields (IStorageFieldsCollection).

[Link].1 Count
Retorna a quantidade de objetos Campo do Storage no objeto Fields. Esta propriedade é somente de leitura.

[Link] Campo do Storage

Esta seção contém informações sobre propriedades do objeto Campo do Storage (IStorageField). Este objeto não
possui eventos nem métodos associados.

[Link].1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Campo do Storage (IStorageField).

[Link].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 do Storage a ser armazenado. Quanto maior o valor desta propriedade, 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. O valor padrão desta
propriedade é 1 (um).

[Link].1.2 DeadBandUnit
Unidade da propriedade DeadBand. Este valor pode ser especificado como um percentual do valor atual do Tag
(0: dbPercent) ou em unidades absolutas (1: dbAbsolute). O valor padrão desta propriedade é 0 (zero).

[Link].1.3 Link
Determina a fonte de dados associada a este Campo do Storage. Esta propriedade não pode ser alterada em
tempo de execução, mesmo que o Campo do Storage esteja inativo.

[Link].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 nenhum dado seja gravado. Por exemplo, se um Tag não está
variando de valor, mesmo assim o valor atual deve ser escrito no banco de dados sempre que o número de
segundos configurado nesta propriedade é atingido. Este comportamento pode ser desabilitado utilizando-se o valor
0 (zero). O valor padrão desta propriedade é 3600 (uma hora).

[Link].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, valor padrão).

[Link].1.6 Name
Esta propriedade retorna ou configura o nome deste Campo do Storage no objeto Storage. Através desta
propriedade é possível buscar itens na Coleção de Campos do Storage (propriedade Fields). O valor padrão desta
propriedade é uma String vazia. Não é permitido utilizar as expressões "Null", "Empty", "Nothing", "Application",
"True" ou "False" para esta propriedade. Esta propriedade não pode ser alterada em tempo de execução. Consulte a
propriedade geral Name para mais informações sobre os caracteres permitidos no nome deste objeto.

400 Objetos de Servidor

[Link].1.7 ScanTime
Retorna ou configura o tempo de varredura em milissegundos de um Campo do Storage, 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 é igual a 0 (zero), o valor da propriedade MaxRecTime é utilizado para este mesmo
propósito (comportamento padrão).

[Link].1.8 Type
Retorna o tipo de dados do Campo do Storage no formato do Storage. Esta propriedade é de leitura e escrita,
mas só aceita mudanças enquanto a coleta de dados para este Campo do Storage ainda não começou. Os valores
possíveis para esta propriedade são 0: Double (padrão), 1: Bit, 2: Text ou 3: Integer.

NOTA
Os tipos de dados Bit, Text e Integer não são submetidos ao algoritmo de compactação do Storage. Portanto,
sempre que há uma variação no valor ou na qualidade do Campo do Storage, o valor é gravado no banco de
dados. As propriedades DeadBand, DeadBandUnit, MaxRecTime e MinRecTime não têm efeito nestes tipos de
dados, pois são exclusivas do algoritmo de compactação.

5.12.4 Sessão do Storage

Esta seção contém informações sobre os métodos do objeto Sessão do Storage (StorageSession). Este objeto não
possui eventos nem propriedades associados.

[Link] Métodos
Esta seção contém informações sobre os métodos do objeto Sessão do Storage (StorageSession).

[Link].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
são omitidos, utiliza-se 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 Tag temporário (obrigatório). Consulte a
propriedade geral Name para mais informações sobre
os caracteres permitidos nos nomes de objetos

Type Tipo do Tag. Os valores possíveis são 0: Double, 1: Bit, 2:

Text ou 3: Integer. Se este parâmetro é omitido, utiliza o
valor 0: Double

MinRecTime Intervalo mínimo de tempo entre as gravações. Se este

parâmetro é omitido, utiliza o valor 0 (zero)

MaxRecTime Intervalo máximo de tempo sem gravações. Se este

parâmetro é omitido, utiliza o valor 3600

DeadBand Banda morta do Tag temporário. Se este parâmetro é

omitido, utiliza o valor 1 (um)

DeadBandUnit Unidade de banda morta do Tag temporário. Os valores

possíveis são 0: Porcentagem ou 1: Absoluta. Se este
parâmetro é omitido, utiliza o valor 1: Absoluta

ScanTime Tempo de varredura do Tag temporário. Se este

parâmetro é omitido, utiliza o valor 0 (zero)

Este método retorna Verdadeiro se o Tag foi corretamente adicionado na Sessão e Falso caso contrário.

Objetos de Servidor 401

[Link].2 AddValue
AddValue(FieldName, Timestamp, Quality, Value)
Adiciona um valor a um Tag temporário na Sessão. Os parâmetros deste método estão descritos na tabela a seguir.
Parâmetros do método AddValue
PARÂMETRO DESCRIÇÃO
FieldName Nome do campo ao qual o valor é adicionado. Este
nome deve existir na configuração original do Storage,
ou então deve ter sido adicionado previamente pelo
método AddField

Timestamp Estampa de tempo do valor a ser adicionado

Quality Qualidade do valor a ser adicionado

Value Valor a ser adicionado

Este método retorna Verdadeiro se o valor foi adicionado corretamente e Falso caso contrário.

[Link].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.

402 Objetos de Servidor

CAPÍTULO
Dúvidas Mais Frequentes
6
Como abrir uma Tela janelada que mostre a barra de título com botões de minimizar, maximizar e
fechar?
Para isto, deve-se utilizar o método SetFrameOptions do Divisor. O parâmetro Flags especifica características da
janela. O valor 127 define uma janela com os botões Minimizar, Maximizar e Fechar visíveis.

Como abrir uma Tela modal?

Para abrir uma Tela modal, utilize o método DoModal do Viewer, conforme o exemplo a seguir.
[Link] "Tela1", "Título1", 0, 0, 400, 200, 0, 1

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 copiar valores de uma linha do E3Browser para um Tag?

Primeiro, selecione a linha (ou o registro) desejada no E3Browser. Depois, utilize o método GetColumnValue do
E3Browser. O parâmetro Index é o índice da coluna a ser copiada, iniciando em 0 (zero).

Como impedir que o usuário digite uma String em um SetPoint?

Verifique se o valor digitado é numérico no evento Validate, conforme o exemplo a seguir.
Sub Text1_Validate(Cancel, NewValue)
If NOT IsNumeric(newValue) Then
MsgBox "O valor deve ser numérico."
Cancel = True
End If
End Sub

Como abrir um calendário para selecionar data e hora ao clicar em um SetPoint?

Usando o método ShowDatePicker no evento Click do SetPoint, conforme o exemplo a seguir.
Sub Text1_Click()
Dim datevalue
If [Link](datevalue) Then
Value = datevalue
End If
End Sub

Como reconhecer todos os alarmes de uma Área?

Para reconhecer todos os alarmes de uma Área por script, é possível utilizar o método AckArea. Este método tem
dois parâmetros, a saber:
· Area é o nome da Área de Alarmes da qual se quer reconhecer o alarme
· User é o nome do operador logado, que pode ser o item [Link]

Para reconhecer todos os alarmes ativos, pode-se utilizar o método AckAllAlarms.

Como executar uma ação ao clicar em um botão específico do mouse ou em uma tecla?
Usando os eventos KeyDown ou KeyUp da Tela. Estes eventos são disparados quando uma tecla é pressionada ou
solta e retornam dois parâmetros. Um é o código da tecla que foi pressionada, e o outro indica a condição das teclas
SHIFT e CTRL no momento em que a tecla foi pressionada. A ideia é comparar o parâmetro de retorno do evento com
o código do caractere esperado.

Como criar um script WhileRunning?

Criando um evento associado a alguma propriedade que tenha sempre o mesmo valor. Por exemplo, a propriedade
Visible de um objeto de Tela. Enquanto o objeto está visível, ou seja, com a propriedade Visible igual a Verdadeiro,

Dúvidas Mais Frequentes 403

o script é executado. Porém, recomenda-se evitar o uso de scripts do tipo WhileRunning, pois podem prejudicar a
performance da aplicação. Na maioria dos casos, podem ser substituídos por Associações.

Como criar um script OnValueChanged?

Criando um evento associado à propriedade Value de um Tag, e que seja executado quando a propriedade alterar o
valor.

NOTA
Atenção para não usar métodos do Viewer no Servidor, como por exemplo o método MsgBox. Se for o caso, o
evento pode ser criado na Tela ou até no próprio objeto Viewer, ao invés de ser criado no Tag.

Como criar Tags e objetos de Tela em tempo de execução?

Usando o método AddObject. O script a seguir cria Tags de Comunicação no Driver Driver1.
Set obj = [Link]("Driver1")
For i = 1 To 100
Set tag = [Link]("IOTag", false)
[Link] = "IOTag" & CStr(i)
[Link]
Next

Como mostrar uma mensagem na Tela ao alterar o valor de um Tag?

Criando um evento na Tela associado à propriedade Value do Tag, e que seja executado quando a propriedade
alterar o valor. Neste evento, utilize o método MsgBox para mostrar a mensagem.

Como criar uma Consulta com filtro por data antes de montar um Relatório de Seção?
Para isto, é necessário configurar o objeto Consulta que acompanha o Relatório de Seção e criar as variáveis
necessárias na coluna Filtro. Para isto, consulte o capítulo Consulta. No evento de chamada do Relatório de Seção,
use um script semelhante ao exemplo a seguir.
Set relatorio = [Link]("[Relatório1]")
Set consulta = [Link]()
[Link] "Variavel1", Valor1
[Link] "Variavel2", Valor2
[Link]()

Em que:
· [Relatório1] é o nome do Relatório de Seção 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

Para verificar outros tipos de filtros, consulte o capítulo Consulta ou a documentação disponível no Elipse
Knowledgebase.

Como depurar erros de script no Elipse E3 Viewer e no servidor?

Caso o evento seja executado no Elipse E3 Viewer, utilize o método Trace do Viewer. Caso o evento seja executado
no servidor, utilize o método Trace do servidor.

404 Dúvidas Mais Frequentes

Porto Alegre — RS São Paulo — SP
Rua Mostardeiro, 322/Cj. 902 Rua dos Pinheiros, 870/Cj. 141/142
90430 — Porto Alegre — RS 05422-001 — São Paulo — SP
(+55 51) 4062-5824 (+55 11) 4062-5824
elipse-rs@[Link] elipse-sp@[Link]

Kaohsiung — Taiwan Raleigh — EUA

9F., No.12, Beiping 2nd St., Sanmin Dist. 555 Fayetteville St.
807 — Kaohsiung City — Taiwan 27601 — Raleigh — NC
(+886 7) 323-8468 (+1 919) 642-2423
sales@[Link] sales@[Link]

Curitiba — PR Belo Horizonte — MG Rio de Janeiro — RJ

(+55 41) 4062-5824 (+55 31) 4062-5824 (+55 21) 4062-5824
elipse-pr@[Link] elipse-mg@[Link] elipse-rj@[Link]

Elipse Software Knowledgebase

Integradores Youtube

Certificação Fórum

Documentação Online Ensino à Distância

Gartner, Cool Vendors in Brazil 2014, April 2014.

Gartner does not endorse any vendor, product or service depicted in its
research publications, and does not advise technology users to select only
those vendors with the highest ratings. Gartner research publications
consist of the opinions of Gartner’s research organization and should not
be construed as statements of fact. Gartner disclaims all warranties,
expressed or implied, with respect to this research, including any warranties
of merchantability of fitness for a particular purpose.