Prévia do material em texto

<p>Versão 6.7.234 (16/08/2024)</p><p>Manual de Referência e Scripts</p><p>do Elipse E3</p><p>Copyright © 1999 - 2024 Elipse Software Ltda. Todos os direitos reservados.</p><p>I</p><p>Sumário</p><p>1 Introdução ................................................................................................................................................... 1</p><p>1.1 Objetos ................................................................................................................................................... 1</p><p>1.2 Scripts .................................................................................................................................................... 1</p><p>1.3 Picks ....................................................................................................................................................... 4</p><p>1.4 Eventos Definidos pelo Usuário ....................................................................................................... 11</p><p>2 Programando no Elipse E3 ...................................................................................................................... 14</p><p>2.1 Ambiente de Programação ............................................................................................................... 14</p><p>2.2 Declarando Variáveis ......................................................................................................................... 14</p><p>2.3 Obtendo Referências aos Objetos .................................................................................................... 15</p><p>2.4 Acessando Objetos ............................................................................................................................. 26</p><p>2.5 Trabalhando com Coleções ............................................................................................................... 26</p><p>2.6 Comando Set ....................................................................................................................................... 27</p><p>2.7 E3Globals ............................................................................................................................................. 27</p><p>2.8 Eventos, Métodos e Propriedades Gerais dos Objetos .................................................................. 35</p><p>3 Bibliotecas do Usuário ............................................................................................................................. 54</p><p>3.1 ElipseX ................................................................................................................................................. 54</p><p>4 Visualização .............................................................................................................................................. 59</p><p>4.1 Viewer .................................................................................................................................................. 59</p><p>4.2 Quadros e Divisores ........................................................................................................................... 83</p><p>4.3 Telas e Objetos de Tela ...................................................................................................................... 89</p><p>4.4 E3Alarm ............................................................................................................................................. 170</p><p>4.5 E3Browser ......................................................................................................................................... 194</p><p>4.6 E3Chart .............................................................................................................................................. 200</p><p>4.7 E3Playback ........................................................................................................................................ 229</p><p>4.8 Relatório de Seção ........................................................................................................................... 230</p><p>4.9 TrendAnalysis ................................................................................................................................... 254</p><p>5 Objetos de Servidor ............................................................................................................................... 257</p><p>5.1 Propriedades Comuns ..................................................................................................................... 257</p><p>5.2 Alarmes ............................................................................................................................................. 259</p><p>5.3 Banco de Dados ................................................................................................................................ 280</p><p>5.4 Coleção de Campos de Usuário de Alarmes ................................................................................. 284</p><p>5.5 Drivers ............................................................................................................................................... 285</p><p>5.6 Fórmulas ........................................................................................................................................... 340</p><p>5.7 Históricos .......................................................................................................................................... 342</p><p>5.8 Informações do Servidor ................................................................................................................. 348</p><p>5.9 Objetos em Tempo de Configuração ............................................................................................. 361</p><p>5.10 Objetos em Tempo de Execução do Servidor ............................................................................. 364</p><p>5.11 Servidor de Dados .......................................................................................................................... 367</p><p>5.12 Storage ............................................................................................................................................ 391</p><p>6 Dúvidas Mais Frequentes ...................................................................................................................... 398</p><p>1</p><p>Introdução</p><p>1</p><p>Introdução</p><p>CAPÍTULO</p><p>Os Scripts são módulos de linguagem de programação nos quais se pode criar procedimentos associados a eventos</p><p>específicos, permitindo uma maior flexibilidade no desenvolvimento de aplicações. Cada objeto (item de um aplicativo)</p><p>do Elipse E3 possui uma lista de eventos previamente definidos, mas também é possível definir novos eventos</p><p>próprios do usuário.</p><p>1.1 Objetos</p><p>Os Objetos são componentes de software reutilizáveis que permitem maximizar o uso e aumentar a qualidade e</p><p>produtividade em seus aplicativos.</p><p>Um objeto no Elipse E3 encapsula ou contém três diferentes partes (propriedades, métodos e eventos) que podem</p><p>ser manipuladas para a utilização das vantagens de sua funcionalidade na aplicação.</p><p>Propriedades definem atributos de um objeto, como a aparência de um objeto de Tela ou o valor inicial de um objeto</p><p>quando o aplicativo é iniciado.</p><p>Métodos são funções que realizam uma ação específica dentro ou com um objeto.</p><p>Eventos são notificações geradas por um objeto em resposta a alguma ocorrência em particular, como um clique de</p><p>mouse ou uma mudança no valor de um Tag, entre outros.</p><p>Uma das principais características dos objetos e das linguagens orientadas a objeto é a capacidade de herança entre</p><p>eles, ou seja, estes podem herdar as características de um ou mais objetos, tendo as mesmas funcionalidades</p><p>específicas. Assim, pode se ter vários objetos trabalhando em conjunto para prover características de um outro objeto</p><p>derivado.</p><p>Tome como exemplo o objeto E3Chart. Ele é composto internamente de vários objetos, como títulos, legendas,</p><p>escalas, divisões,</p><p>método configura a propriedade IsObjectActive deste objeto para Verdadeiro.</p><p>2.8.2.3 AddObject</p><p>AddObject(ClassName, [Activate], [ObjectName])</p><p>Este método adiciona um novo objeto à aplicação. Este método possui o parâmetro ClassName, que indica o tipo de</p><p>objeto que é criado. Por exemplo, para se criar um retângulo na Tela, o parâmetro ClassName deve ser igual a</p><p>"DrawRect". O objeto criado está contido no objeto que chamou este método e pode ser acessado através do</p><p>método Item.</p><p>O parâmetro Activate é opcional e indica se o objeto é ativado após a criação. Se o objeto é ativado, as Associações e</p><p>scripts são habilitados. Se o objeto é criado com o parâmetro Activate em Falso, mais tarde pode ser ativado pelo</p><p>método Activate. Se este parâmetro é omitido, o objeto é ativado após a criação. O valor configurado neste</p><p>parâmetro é usado para configurar a propriedade IsObjectActive do objeto criado.</p><p>O parâmetro ObjectName também é opcional e indica um nome para o objeto criado. Caso o nome já exista, o novo</p><p>nome é automaticamente incrementado. Se este parâmetro é omitido, o novo objeto é nomeado a partir do nome da</p><p>classe definida no parâmetro ClassName. Consulte a propriedade geral Name para mais informações sobre os</p><p>caracteres permitidos nos nomes de objetos.</p><p>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</p><p>criado, pode-se utilizar o método IsObject do VBScript.</p><p>NOTA</p><p>Apenas objetos que possuem a opção Inserir no seu menu contextual podem acessar este método.</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/isobject-function</p><p>37</p><p>Programando no Elipse E3</p><p>2.8.2.4 Context</p><p>Context(ContextName)</p><p>Retorna o objeto que implementa o contexto indicado pelo parâmetro ContextName, que deve ser uma String entre</p><p>aspas duplas. Este método falha se nenhum objeto na hierarquia superior do objeto que está chamando este método</p><p>implementar o contexto indicado. Os seguintes contextos estão disponíveis:</p><p>· Container: Objetos de servidor e do Viewer, ou seja, objetos inseridos em arquivos de projeto ou em pastas</p><p>dentro de projetos</p><p>· Area: Áreas de Alarme, ou qualquer objeto de servidor cuja propriedade IsAlarmArea esteja configurada para</p><p>Verdadeiro</p><p>NOTA</p><p>Os nomes dos contextos estão sempre em inglês, e não diferenciam maiúsculas de minúsculas. Para verificar o</p><p>contexto a que um objeto pertence, abra sua Janela de Propriedades, selecione a aba Item e verifique os contextos</p><p>válidos no quadro Contextos. Caso um objeto defina mais de um contexto, os nomes são apresentados em ordem</p><p>alfabética, separados por vírgulas.</p><p>2.8.2.5 Deactivate</p><p>Deactivate()</p><p>Este método desativa um objeto criado ou previamente ativado pelo método Activate. Pode-se desativar um objeto</p><p>quando é necessário realizar uma configuração prévia, como por exemplo na inicialização de propriedades, ou</p><p>quando é necessário realizar testes nos quais o objeto não pode estar presente e ativo. O script a seguir contém um</p><p>exemplo de uso deste método.</p><p>Sub CommandButton1_Click()</p><p>Dim obj, novo</p><p>Set obj = Application.GetObject("Dados")</p><p>Set novo = obj.AddObject("DemoTag", True)</p><p>' Desativa o objeto</p><p>novo.Deactivate()</p><p>End Sub</p><p>NOTA</p><p>Desativar um objeto usando este método configura a propriedade IsObjectActive deste objeto para Falso.</p><p>2.8.2.6 DeleteObject</p><p>DeleteObject(ChildName)</p><p>Apaga do projeto o objeto especificado. O parâmetro ChildName é uma String (ignora maiúsculas e minúsculas) que</p><p>indica o objeto filho que se deseja apagar. O método retorna Verdadeiro caso a operação de apagar o objeto tenha</p><p>sido bem-sucedida, ou Falso caso o objeto filho não exista.</p><p>Para se apagar um objeto a partir de uma referência a um elemento, utilize este método no objeto pai. O script a</p><p>seguir contém um exemplo de uso deste método.</p><p>Sub CommandButton1_Click()</p><p>Set obj = Application.GetObject("Dados")</p><p>If obj.DeleteObject("Tag001") Then</p><p>MsgBox("Tag apagado com sucesso!")</p><p>Else</p><p>MsgBox("Falha ao apagar: o Tag não existe.")</p><p>End If</p><p>End Sub</p><p>NOTA</p><p>Apenas objetos que possuem a opção Inserir no seu menu contextual podem acessar este método.</p><p>2.8.2.7 GetChildObject</p><p>GetChildObject(ObjectPath)</p><p>Este método retorna uma referência para o objeto filho apontado pelo parâmetro ObjectPath. Com isto é possível</p><p>acessar todas as propriedades e métodos deste objeto, semelhante ao funcionamento do método GetObject. Este</p><p>Programando no Elipse E3</p><p>38</p><p>método falha se o caminho apontado por ObjectPath contiver uma propriedade ou método ao final. O caminho</p><p>apontado pelo objeto filho não é um caminho desde a raiz (o arquivo .prj) e sim um caminho sempre a partir do</p><p>objeto onde o método é chamado.</p><p>NOTA</p><p>Este método NÃO existe no objeto Application do Servidor e nem nas Pastas de Aplicativo, porém existe no objeto</p><p>Application do Viewer e é acessível mesmo em um Elipse E3 Viewer em modo Somente Leitura.</p><p>2.8.2.8 GetObject</p><p>GetObject(ObjectPath)</p><p>Este método retorna a referência do objeto especificado em ObjectPath. Isto permite acessar todas as propriedades</p><p>ou métodos do objeto. Esta é uma prática bastante comum na programação de scripts no Elipse E3, facilita a</p><p>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.</p><p>Sub CommandButton1_Click()</p><p>' Atribui o valor 20 à propriedade Value do objeto</p><p>' TagInterno1 que está em Dados.</p><p>Set tag = Application.GetObject("Dados.TagInterno1")</p><p>tag.Value = 20</p><p>End Sub</p><p>2.8.2.9 Item</p><p>Item(ItemId)</p><p>Retorna a referência para o objeto filho ItemId do objeto que chamou este método. Este método pode buscar um</p><p>objeto tanto pelo nome quanto pelo índice, um inteiro entre 1 (um) e o valor especificado na propriedade Count. Se o</p><p>índice ou o nome especificado é válido, este método retorna a referência ao objeto. Caso contrário, o método retorna</p><p>um erro de "Parâmetro Inválido". O script a seguir contém um exemplo de uso deste método.</p><p>Sub Tela1_Click()</p><p>' Atribui a obj a referência para o objeto filho Botao1</p><p>' de Tela1.</p><p>Set obj = Item("Botao1")</p><p>' Configura a propriedade BackColor de obj, ou seja,</p><p>' de Botao1.</p><p>obj.BackColor = RGB(255, 0, 0)</p><p>End Sub</p><p>2.8.2.10 RunEvent</p><p>RunEvent(EventName, [Arguments])</p><p>Executa o script ou scripts associados ao evento indicado pelo parâmetro EventName, que deve ser uma String. O</p><p>parâmetro Arguments é opcional e deve ser usado nos casos em que o evento necessite de argumentos. Estes</p><p>argumentos devem estar separados por vírgulas. Este método falha caso o evento indicado não tenha nenhum script</p><p>a ser executado.</p><p>2.8.2.11 RunProcedure</p><p>RunProcedure(ProcedureName, [Arguments])</p><p>Executa o script ou scripts associados ao procedimento (procedure) ou função (function) indicado pelo parâmetro</p><p>ProcedureName, que deve ser uma String. O parâmetro Arguments é opcional e deve ser usado nos casos em que o</p><p>procedimento ou função necessitem de argumentos. Estes argumentos devem estar separados por vírgulas. Este</p><p>método falha caso o procedimento ou função indicados não tenham nenhum script a ser executado. Este método</p><p>retorna um valor nos casos em que a função indicada pelo parâmetro ProcedureName também retorne um valor.</p><p>2.8.2.12 Save</p><p>Save()</p><p>Este método salva o objeto especificado, que foi modificado em tempo de execução (runtime). Os objetos filhos</p><p>também são salvos, conforme as especificações do objeto pai. Este método não é válido para os objetos Tela e</p><p>Viewer. O script a seguir contém um exemplo de uso deste método.</p><p>Sub CommandButton1_Click()</p><p>Set area = Application.GetObject("ConfigAlarms")._</p><p>AddObject("Area", True)</p><p>39</p><p>Programando no Elipse E3</p><p>Application.GetObject("ConfigAlarms").Save()</p><p>End Sub</p><p>NOTA</p><p>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</p><p>atualização do projeto. Para isto, clique com o botão direito do mouse no nome do projeto e selecione a opção</p><p>Atualizar.</p><p>2.8.3 Propriedades</p><p>Todo objeto possui Propriedades, que servem para guardar informações a respeito das características daquele</p><p>objeto. Por exemplo, um objeto do tipo Retângulo possui a propriedade Name, que contém o nome, e as</p><p>propriedades Width e Height, que guardam a largura e altura, respectivamente, entre outras propriedades.</p><p>Neste capítulo são listadas todas as propriedades gerais dos objetos do Elipse E3. Cada tópico traz o nome da</p><p>propriedade, a descrição e, quando aplicável, um exemplo de uso. As propriedades são identificadas por um ícone</p><p>que indica o tipo de dados suportado no conteúdo. Os tipos de dados disponíveis estão descritos na tabela a seguir.</p><p>Tipos de dados disponíveis</p><p>TIPO DE DADOS DESCRIÇÃO</p><p>Booleano Representa os valores Verdadeiro (True) ou Falso (False)</p><p>Coleção Representa uma coleção de objetos</p><p>Item de Coleção Representa um item de uma coleção de objetos</p><p>Cor Representa uma cor no formato RGB</p><p>Data e Hora Representa uma data no calendário Gregoriano,</p><p>iniciando em 1899</p><p>Enumeração Representa um conjunto determinado de valores</p><p>Fonte Representa uma fonte a ser aplicada a um texto</p><p>GUID Representa um valor GUID (Globally Unique Identifier ou</p><p>Identificador Único Global)</p><p>Propriedade Indexada Representa uma propriedade cujos valores podem ser</p><p>acessados através de um índice</p><p>Link Representa uma associação entre objetos</p><p>Número Representa um valor inteiro ou Double, positivo ou</p><p>negativo, a ser definido pela propriedade</p><p>Figura Representa uma imagem no formato BMP, EMF, GIF,</p><p>ICO, JPEG, PNG, TIFF ou WMF</p><p>Texto Representa um texto</p><p>Variant Representa um valor variável, que pode assumir vários</p><p>formatos</p><p>Algumas propriedades podem propagar seus valores à mesma propriedade nos objetos filhos. Neste caso, são</p><p>chamadas de propriedades propagáveis. Pode-se, no entanto, forçar a propriedade do objeto filho a se comportar</p><p>de modo diferente.</p><p>NOTA</p><p>O Elipse E3 utiliza para definição de coordenadas e espessura o sistema Himetric. Neste sistema, cada unidade</p><p>lógica equivale a um milésimo de centímetro, ou seja, cada 1000 unidades equivalem a um centímetro. Assim, este é</p><p>o padrão adotado na descrição das propriedades do Elipse E3, quando aplicável.</p><p>Programando no Elipse E3</p><p>40</p><p>2.8.3.1 Application</p><p>Esta propriedade retorna o objeto de aplicação relacionado ao contexto atual do objeto. Esta propriedade é</p><p>somente de leitura. Com o objeto Aplicação é possível, por exemplo, buscar outros objetos presentes no aplicativo. O</p><p>script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub Tela1_Click()</p><p>' Quando clica na tela, atribui um valor e abre um MessageBox</p><p>set obj = Application.GetObject("Dados.TagInterno1")</p><p>obj.Value = 100</p><p>MsgBox "Valor do TagInterno1: " & obj.Value</p><p>End Sub</p><p>2.8.3.2 Count</p><p>Retorna o número de objetos filhos, ou itens, que um objeto possui. Esta propriedade funciona em conjunto com o</p><p>método Item. Se o objeto não possuir filhos, o valor retornado é 0 (zero). Esta propriedade é somente de leitura. O</p><p>script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub Tela1_Click()</p><p>' Busca todos os objetos de tela</p><p>' e ajusta a propriedade</p><p>' ForegroundColor para vermelho</p><p>Dim obj</p><p>For i = 1 To Count</p><p>Set obj = Item(i) ' Objeto filho</p><p>obj.ForegroundColor = RGB(255, 0, 0)</p><p>Next</p><p>End Sub</p><p>2.8.3.3 DocString</p><p>Texto livre que tem por objetivo possibilitar a documentação das funcionalidades ou características do objeto pelos</p><p>programadores do projeto. O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub CommandButton1_Click()</p><p>Docstring = "Este botão ativa o condensador do sistema."</p><p>MsgBox Docstring</p><p>End Sub</p><p>2.8.3.4 ExposeToOpc</p><p>Indica se um objeto e os respectivos filhos devem ser expostos no Servidor OPC UA. Os valores possíveis para esta</p><p>propriedade são 0 - eeUseParentConfig: Usa a configuração desta propriedade no respectivo objeto pai (padrão), 1</p><p>- eeExpose: Expõe este objeto, independente da configuração no respectivo objeto pai ou 2 - eeDontExpose: Não</p><p>expõe este objeto, independente da configuração do respectivo objeto pai.</p><p>NOTA</p><p>Os objetos Servidor de Alarmes, Configuração de Alarmes, Banco de Dados e os objetos do Viewer não podem ser</p><p>expostos no Servidor OPC UA.</p><p>2.8.3.5 IsObjectActive</p><p>Esta propriedade indica se um objeto está ativado. Em tempo de execução, todos os objetos definidos em um</p><p>projeto retornam Verdadeiro nesta propriedade até que seja usado o método Deactivate no objeto ou em um de</p><p>seus objetos pai. Objetos criados em tempo de execução usando o método AddObject configuram esta propriedade</p><p>de acordo com o parâmetro Activate deste método. Para o caso de objetos pré-ativados em Hot-Standby, ou seja, os</p><p>objetos configurados na opção Serviços pré-ativados no servidor reserva da aba Opções na janela de configuração</p><p>do Domínio do E3 Admin, têm esta propriedade configurada em Falso até que o servidor reserva assuma a execução</p><p>do Domínio.</p><p>2.8.3.6 Links</p><p>Retorna um objeto que é uma coleção das conexões (ou Associações) de um objeto qualquer do Elipse E3. Esta</p><p>propriedade é somente de leitura. Consulte o tópico Coleção de Associações para mais informações sobre a coleção</p><p>de objetos retornados por esta propriedade.</p><p>41</p><p>Programando no Elipse E3</p><p>2.8.3.7 Name</p><p>Identifica um objeto na aplicação. Esta propriedade não pode ser alterada com o objeto ativo. Ao alterar esta</p><p>propriedade, é necessário modificar todas as propriedades ou scripts que utilizam este objeto. Não é aconselhável a</p><p>alteração desta propriedade em tempo de execução.</p><p>Os caracteres a seguir são reservados e automaticamente substituídos pelo caractere de sublinhado (_):</p><p>· Qualquer caractere com código ASCII menor que 32 e o caractere com código ASCII 127 (DEL)</p><p>· Colchetes ([ e ]), quando usados em expressões</p><p>· Barra invertida (\), que é usada em caminhos de recursos</p><p>· Dois pontos (:), que são usados em caminhos de Domínios Remotos e bancos de dados</p><p>· Aspas duplas ("), que são usadas para delimitar Strings em expressões</p><p>· Ponto de interrogação (?), que é usado para delimitar opções na propriedade SplitLink e nos métodos</p><p>ShowScreen e OpenScreen do Divisor, além do evento OnPreShow da Tela</p><p>Os demais caracteres podem ser utilizados, mas devem ser delimitados por colchetes quando utilizados em um</p><p>caminho nos seguintes casos:</p><p>· Contenha qualquer caractere que não seja uma letra (a-z | A-Z) quando usado como primeiro caractere do</p><p>caminho</p><p>· Contenha qualquer caractere que não seja uma letra (a-z | A-Z), um número (0-9) ou um sublinhado (_) quando</p><p>usado após o primeiro caractere do caminho</p><p>2.8.3.8 ObjectEvents</p><p>Retorna um objeto que é uma coleção de Eventos, tanto pré-definidos quanto de usuário, de um objeto qualquer</p><p>do Elipse E3. Esta propriedade é somente de leitura. Consulte o tópico Coleção de Eventos para mais informações</p><p>sobre a coleção de objetos retornados por esta propriedade.</p><p>2.8.3.9 Parent</p><p>Retorna o objeto pai deste objeto. Sendo assim, se um objeto está inserido na Tela, esta propriedade retorna o</p><p>valor "Tela". Da mesma forma, se um Tag Interno está inserido diretamente abaixo de um Servidor de Dados, esta</p><p>propriedade deste Tag Interno aponta para o Servidor de Dados. Esta propriedade é somente de leitura. O script a</p><p>seguir contém um exemplo de uso desta propriedade.</p><p>Sub Retangulo1_Click()</p><p>' Ao clicar no Retangulo1,</p><p>' troca a cor do Retangulo2</p><p>Parent.Item("Retangulo2").ForegroundColor = RGB(255, 0, 0)</p><p>End Sub</p><p>2.8.3.10 PathContainer</p><p>Retorna uma String contendo o caminho do objeto que contém o objeto atual,</p><p>incluindo as Pastas. Este valor é</p><p>determinado apenas no momento em que é requisitado, por isto não é recomendado criar Associações para esta</p><p>propriedade. Esta propriedade é somente de leitura.</p><p>2.8.3.11 PathName</p><p>Identifica o caminho de um objeto na aplicação. Esta propriedade é somente de leitura. O script a seguir contém um</p><p>exemplo de uso desta propriedade.</p><p>Sub CommandButton9_Click()</p><p>MsgBox "O caminho da Tela é " & (Screen.PathName)</p><p>End Sub</p><p>2.8.3.12 PathVolume</p><p>Retorna uma String contendo o nome do arquivo .prj ou .lib que contém o objeto. No Elipse E3 Studio, esta</p><p>propriedade retorna o caminho completo do projeto ou biblioteca (c:\folder\folder\volume.prj). Em tempo de</p><p>execução, os objetos que executam no Elipse E3 Viewer retornam sempre uma String vazia. Já os que executam no</p><p>servidor retornam o caminho relativo do projeto ou biblioteca, conforme esteja armazenado no Domínio (volume.prj).</p><p>Este valor é determinado apenas no momento em que é requisitado, por isto não é recomendado criar Associações</p><p>para esta propriedade. Esta propriedade é somente de leitura.</p><p>Programando no Elipse E3</p><p>42</p><p>2.8.4 Coleção de Associações</p><p>Esta seção contém informações sobre os métodos e propriedades comuns à coleção de Associações (Links) de um</p><p>objeto qualquer do Elipse E3, retornada pela propriedade Links.</p><p>2.8.4.1 Métodos Comuns</p><p>Esta seção contém informações sobre os métodos comuns à coleção de Associações (Links) retornada pela</p><p>propriedade Links.</p><p>2.8.4.1.1 CreateLink</p><p>CreateLink(Property, Source, [BindType])</p><p>Este método permite criar uma Associação com uma propriedade de um objeto. Em caso de sucesso, este método</p><p>retorna o objeto criado. Caso contrário, ocorre um erro de script e o método retorna Nothing. Este método possui</p><p>os parâmetros Property, que especifica o nome da propriedade para a qual é criada a Associação, Source, que</p><p>especifica o nome do objeto de origem da Associação, e BindType, que é opcional e especifica o tipo de Associação a</p><p>ser criada. Se este parâmetro é omitido, cria uma Associação Simples.</p><p>NOTA</p><p>Nem todas as propriedades existentes em um objeto permitem a criação de Associações. Para verificar quais as</p><p>propriedades permitem este recurso, acesse a aba Associações da Janela de Propriedades do objeto. Se a</p><p>propriedade é inválida para uma Associação, não existir ou já possuir uma Associação, ocorre um erro de script.</p><p>Opções disponíveis para o parâmetro BindType</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - Associação Simples Na Associação Simples, o valor da origem é copiado</p><p>para a propriedade toda vez que é modificado</p><p>1 - Associação Bidirecional Na Associação Bidirecional ocorre o mesmo que na</p><p>Simples, mas caso haja uma variação na propriedade, o</p><p>valor é copiado para a origem, gerando assim uma</p><p>Associação de duas direções</p><p>2 - Associação Analógica A Associação Analógica estabelece uma escala de</p><p>conversões entre a variável de origem e a propriedade</p><p>3 - Associação Digital Na Associação Digital são especificados valores fixos ou</p><p>alternantes para a propriedade, que são atribuídos de</p><p>acordo com a fonte ser verdadeira ou falsa</p><p>4 - Associação por Tabela Na Associação por Tabela pode-se estabelecer</p><p>condições entre a variável, os valores e o destino. Na</p><p>tabela são especificados os valores mínimos e máximos</p><p>e demais configurações</p><p>5 - Associação Reversa A Associação Reversa é uma Associação unidirecional da</p><p>propriedade para a fonte</p><p>6 - Associação Múltipla A Associação Múltipla é semelhante a uma Associação</p><p>por Tabela, exceto que cada linha da Associação permite</p><p>buscar seu valor de uma fonte diferente</p><p>No exemplo a seguir, clicar no Botão de Comando cria uma Associação Bidirecional para o valor de um Tag Interno</p><p>no objeto Texto1, ou seja, configura o parâmetro BindType para o valor 1 (um).</p><p>Sub CommandButton1_Click()</p><p>On Error Resume Next</p><p>Dim bndType, bndValue</p><p>bndType = 1 'Associação Bidirecional</p><p>Set bndValue = Screen.Item("Texto1").Links.Item("Value")</p><p>If bndValue Is Nothing Then</p><p>MsgBox "Criando uma Associação Bidirecional"</p><p>Set bndValue = Screen.Item("Texto1").Links.CreateLink("Value", "Dados.TagInterno1.Value",</p><p>bndType)</p><p>43</p><p>Programando no Elipse E3</p><p>Else</p><p>MsgBox "Texto1 já tem uma Associação para " & bndValue.Source</p><p>End If</p><p>End Sub</p><p>2.8.4.1.2 Item</p><p>Item(ItemId)</p><p>Este método retorna um objeto Associação de uma determinada propriedade de um objeto. Se é um texto, o</p><p>parâmetro ItemId especifica o nome da propriedade cuja Associação deseja-se acessar. A Associação também pode</p><p>ser acessada por um índice numérico. Este índice deve estar entre 1 (um) e Count. Caso não exista Associação com a</p><p>propriedade, ou o índice seja inválido, ocorre um erro de script. Assim como as demais coleções, a coleção de</p><p>Associações permite o uso da declaração For Each do VBScript. O script a seguir contém um exemplo de uso deste</p><p>método.</p><p>Sub Texto1_Click()</p><p>For Each Link In Links</p><p>MsgBox "Origem do link: " & Link.Source</p><p>Next</p><p>End Sub</p><p>2.8.4.1.3 RemoveLink</p><p>RemoveLink(Property)</p><p>Este método remove uma Associação com a propriedade especificada por Property, caso exista. Caso não exista</p><p>Associação com a propriedade especificada, este método não tem efeito. O script a seguir contém um exemplo de</p><p>uso deste método.</p><p>Sub CommandButton2_Click()</p><p>On Error Resume Next</p><p>Dim Bind</p><p>Set Bind = Screen.Item("ScrollBar1").Links.Item("Value")</p><p>If Bind Is Nothing Then</p><p>' Se a conexão não existe</p><p>MsgBox "ScrollBar1 não está conectado."</p><p>Else</p><p>MsgBox "ScrollBar1 está ligado à " & Bind.Source & "."</p><p>MsgBox "Removendo o link."</p><p>Screen.Item("ScrollBar1").Links.RemoveLink("Value")</p><p>End If</p><p>End Sub</p><p>2.8.4.2 Propriedades Comuns</p><p>Esta seção contém informações sobre as propriedades comuns à coleção de Associações (Links) retornada pela</p><p>propriedade Links.</p><p>2.8.4.2.1 Count</p><p>Retorna o número de objetos filhos, ou itens, de uma coleção de Associações. Esta propriedade trabalha em</p><p>conjunto com o método Item. Se a coleção não possui objetos filhos, o valor retornado é 0 (zero). Esta propriedade é</p><p>somente de leitura.</p><p>2.8.4.3 Associações</p><p>Esta seção contém informações sobre os objetos do tipo Associação contidos na coleção de Associações retornada</p><p>pela propriedade Links. Os tipos de Associações disponíveis são os seguintes:</p><p>· Analógica</p><p>· Bidirecional</p><p>· Digital</p><p>· Múltipla</p><p>· Por Tabela</p><p>· Reversa</p><p>· Simples</p><p>https://docs.microsoft.com/pt-br/previous-versions/windows/internet-explorer/ie-developer/scripting-articles/tywtbxd0(v=vs.84)</p><p>Programando no Elipse E3</p><p>44</p><p>2.8.4.3.1 Propriedades Comuns</p><p>Esta seção contém informações sobre as propriedades comuns aos objetos contidos na coleção de Associações</p><p>retornada pela propriedade Links.</p><p>2.8.4.3.1.1 Property</p><p>Especifica o nome da propriedade que está conectada. Ao ser modificada, permite deslocar a Associação para</p><p>outra propriedade do mesmo objeto. O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub CommandButton1_Click()</p><p>Dim bind</p><p>Set bind = Screen.Item("TableBind").Links.Item(1)</p><p>bind.Property = "Caption"</p><p>End Sub</p><p>2.8.4.3.1.2 Source</p><p>Especifica a fonte da Associação, que pode ser o nome de outro objeto da aplicação ou uma expressão mais</p><p>complexa, acessando vários objetos. O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub CommandButton1_Click()</p><p>Dim bind</p><p>Set bind = Screen.Item("TableBind").Links.Item(1)</p><p>bind.Source = "Dados.TagDemo1.Value"</p><p>End Sub</p><p>2.8.4.3.1.3 Type</p><p>Esta propriedade é somente de leitura e informa o tipo de Associação. As opções disponíveis para esta</p><p>propriedade estão descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade Type</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - bsSimple Associação Simples</p><p>1 -</p><p>bsSimpleBiDir Associação Bidirecional</p><p>2 - bsAnalog Associação Analógica</p><p>3 - bsAnimation Associação Digital</p><p>4 - bsTable Associação por Tabela</p><p>5 - bsReverse Associação Reversa</p><p>6 - bsMultiSource Associação Múltipla</p><p>2.8.4.3.2 Associação Analógica</p><p>Esta seção contém informações sobre as propriedades do objeto Associação Analógica (AnalogBind). Este objeto não</p><p>possui eventos nem métodos associados.</p><p>2.8.4.3.2.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Associação Analógica (AnalogBind).</p><p>DstHiValue</p><p>Esta propriedade especifica o valor máximo atingido na propriedade. O script a seguir contém um exemplo de uso</p><p>desta propriedade.</p><p>Sub DstHiValue_ValueChange()</p><p>On Error Resume Next</p><p>Dim Bind</p><p>Set Bind = Screen.Item("ScrollBar1").Links.Item("Value")</p><p>Screen.Item("ScrollBar1").Max = Value</p><p>If Bind Is Nothing Then</p><p>MsgBox "ScrollBar1 não tem associação."</p><p>Else</p><p>MsgBox "ScrollBar1 está associado a '" & Bind.Source & "'"</p><p>MsgBox "Mudando DstHiValue de " &_</p><p>Bind.DstHiValue & " para " & Value</p><p>Bind.DstHiValue = Value</p><p>45</p><p>Programando no Elipse E3</p><p>End If</p><p>End Sub</p><p>DstLoValue</p><p>Esta propriedade especifica o valor mínimo atingido na propriedade. O script a seguir contém um exemplo de uso</p><p>desta propriedade.</p><p>Sub DstLoValue_ValueChange()</p><p>On Error Resume Next</p><p>Dim Bind</p><p>Set Bind = Screen.Item("ScrollBar1").Links.Item("Value")</p><p>Screen.Item("ScrollBar1").Min = Value</p><p>If Bind Is Nothing Then</p><p>MsgBox "ScrollBar1 não tem associação."</p><p>Else</p><p>MsgBox "ScrollBar1 está associado a '" & Bind.Source & "'"</p><p>MsgBox "Mudando DstLoValue de " &_</p><p>Bind.DstLoValue & " para " & Value</p><p>Bind.DstLoValue = Value</p><p>End If</p><p>End Sub</p><p>SrcHiValue</p><p>Esta propriedade especifica o valor máximo atingido na fonte. O script a seguir contém um exemplo de uso desta</p><p>propriedade.</p><p>Sub SrcHiValue_ValueChange()</p><p>On Error Resume Next</p><p>Dim Bind</p><p>Set Bind = Screen.Item("ScrollBar1").Links.Item("Value")</p><p>Screen.Item("ScrollBar2").Max = Value</p><p>If Bind Is Nothing Then</p><p>MsgBox "ScrollBar1 não tem associado."</p><p>Else</p><p>MsgBox "ScrollBar1 está associado a '" & Bind.Source & "'"</p><p>MsgBox "Mudando SrcHiValue de " &_</p><p>Bind.SrcHiValue & " para " & Value</p><p>Bind.SrcHiValue = Value</p><p>End If</p><p>End Sub</p><p>SrcLoValue</p><p>Esta propriedade especifica o valor mínimo atingido na fonte. O script a seguir contém um exemplo de uso desta</p><p>propriedade.</p><p>Sub SrcLoValue_ValueChange()</p><p>On Error Resume Next</p><p>Dim Bind</p><p>Set Bind = Screen.Item("ScrollBar1").Links.Item("Value")</p><p>Screen.Item("ScrollBar2").Min = Value</p><p>If Bind Is Nothing Then</p><p>MsgBox "ScrollBar1 não tem associado."</p><p>Else</p><p>MsgBox "ScrollBar1 está associado a '" & Bind.Source & "'"</p><p>MsgBox "Mudando SrcLoValue de " &_</p><p>Bind.SrcLoValue & " para " & Value</p><p>Bind.SrcLoValue = Value</p><p>End If</p><p>End Sub</p><p>NOTA</p><p>Caso os valores especificados para as propriedades SrcHiValue e SrcLoValue sejam iguais, não é possível executar</p><p>a escala, e a Associação funciona como se fosse uma Associação Simples.</p><p>2.8.4.3.3 Associação Bidirecional</p><p>Esta seção contém informações sobre as propriedades do objeto Associação Bidirecional (AgSimple). Este objeto não</p><p>possui eventos nem métodos associados.</p><p>2.8.4.3.3.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Associação Bidirecional (AgSimple).</p><p>Programando no Elipse E3</p><p>46</p><p>BiDirectional</p><p>Esta propriedade retorna Verdadeiro se a Associação é Bidirecional e Falso se a Associação é Reversa ou Simples.</p><p>2.8.4.3.4 Associação Digital</p><p>Esta seção contém informações sobre as propriedades do objeto Associação Digital (AnimationBind). Este objeto não</p><p>possui eventos nem métodos associados.</p><p>2.8.4.3.4.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Associação Digital (AnimationBind).</p><p>BlinkOff</p><p>Quando esta propriedade estiver configurada para Verdadeiro, a propriedade conectada alterna periodicamente</p><p>entre os valores das propriedades OffValue e BlinkOffValue, caso a fonte retorne Falso. O script a seguir contém um</p><p>exemplo de uso desta propriedade.</p><p>Sub BlinkOff_Change()</p><p>On Error Resume Next</p><p>Dim Bind</p><p>Set Bind = Screen.Item("Retangulo1")._</p><p>Links.Item("ForegroundColor")</p><p>If Bind Is Nothing Then</p><p>MsgBox "Retangulo1 não tem associação."</p><p>Else</p><p>MsgBox "Retangulo1 está associado a '" & Bind.Source & "'"</p><p>MsgBox "Mudando BlinkOff de " & _</p><p>Bind.BlinkOff & " para " & Value</p><p>Bind.BlinkOff = Value</p><p>End If</p><p>End Sub</p><p>BlinkOffValue</p><p>Esta propriedade especifica o valor alternativo a ser assumido periodicamente pela propriedade quando a</p><p>expressão da fonte resultar em Falso e a propriedade BlinkOff estiver configurada em Verdadeiro. O script a seguir</p><p>contém um exemplo de uso desta propriedade.</p><p>Sub BlinkOffValue_Click()</p><p>On Error Resume Next</p><p>Dim Value</p><p>If Application.ShowPickColor_</p><p>(Value, ForegroundColor, 400, 300) Then</p><p>Dim Bind</p><p>Set Bind = Screen.Item("Retangulo1").Links._</p><p>Item("ForegroundColor")</p><p>If Bind Is Nothing Then</p><p>MsgBox "Retangulo1 não tem associação."</p><p>Else</p><p>MsgBox "Retangulo1 está associado a '"& Bind.Source & "'"</p><p>MsgBox "Mudando BlinkOffValue de " &_</p><p>Bind.BlinkOffValue & " para " & Value</p><p>Bind.BlinkOffValue = Value</p><p>End If</p><p>ForegroundColor = Value</p><p>End If</p><p>End Sub</p><p>BlinkOn</p><p>Quando esta propriedade estiver configurada para Verdadeiro, a propriedade conectada alterna periodicamente</p><p>entre os valores das propriedades OnValue e BlinkOnValue, caso a fonte retorne Verdadeiro. O script a seguir</p><p>contém um exemplo de uso desta propriedade.</p><p>Sub BlinkOn_Change()</p><p>On Error Resume Next</p><p>Dim Bind</p><p>Set Bind =_</p><p>Screen.Item("Retangulo1").Links.Item("ForegroundColor")</p><p>If Bind Is Nothing Then</p><p>MsgBox "Retangulo1 não tem associação."</p><p>Else</p><p>MsgBox "Retangulo1 está associado a '" & Bind.Source & "'"</p><p>MsgBox "Mudando BlinkOn de " & Bind._</p><p>BlinkOn & " para " & Value</p><p>Bind.BlinkOn = Value</p><p>47</p><p>Programando no Elipse E3</p><p>End If</p><p>End Sub</p><p>BlinkOnValue</p><p>Esta propriedade especifica o valor alternativo a ser assumido periodicamente pela propriedade quando a</p><p>expressão da fonte resultar em Verdadeiro e a propriedade BlinkOn estiver configurada para Verdadeiro. O script a</p><p>seguir contém um exemplo de uso desta propriedade.</p><p>Sub BlinkOnValue_Click()</p><p>On Error Resume Next</p><p>Dim Value</p><p>If Application.ShowPickColor_</p><p>(Value, ForegroundColor, 400, 300) Then</p><p>Dim Bind</p><p>Set Bind = Screen.Item("Retangulo1").Links._</p><p>Item("ForegroundColor")</p><p>If Bind Is Nothing Then</p><p>MsgBox "Retangulo1 não tem associação."</p><p>Else</p><p>MsgBox "Retangulo1 está associado a '"& Bind.Source & "'"</p><p>MsgBox "Mudando BlinkOnValue de " &_</p><p>Bind.BlinkOnValue & " para " & Value</p><p>Bind.BlinkOnValue = Value</p><p>End If</p><p>ForegroundColor = Value</p><p>End If</p><p>End Sub</p><p>OffValue</p><p>Esta propriedade especifica o valor assumido pela propriedade quando a expressão da fonte resultar em Falso. O</p><p>script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub OffValue_Click()</p><p>On Error Resume Next</p><p>Dim Value</p><p>If Application.ShowPickColor_</p><p>(Value, ForegroundColor, 400, 300) Then</p><p>Dim Bind</p><p>Set Bind = Screen.Item("Retangulo1").Links._</p><p>Item("ForegroundColor")</p><p>If Bind Is Nothing Then</p><p>MsgBox "Retangulo1 não tem associação."</p><p>Else</p><p>MsgBox "Retangulo1 está associado a '"& Bind.Source & "'"</p><p>MsgBox "Mudando OffValue de " &_</p><p>Bind.OffValue & " para " & Value</p><p>Bind.OffValue = Value</p><p>End If</p><p>ForegroundColor = Value</p><p>End If</p><p>End Sub</p><p>OnValue</p><p>Esta propriedade especifica o valor assumido pela propriedade quando a expressão da fonte</p><p>resultar em</p><p>Verdadeiro. O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub OnValue_Click()</p><p>On Error Resume Next</p><p>Dim Value</p><p>If Application.ShowPickColor_</p><p>(Value, ForegroundColor, 400, 300) Then</p><p>Dim Bind</p><p>Set Bind = Screen.Item("Retangulo1").Links._</p><p>Item("ForegroundColor")</p><p>If Bind Is Nothing Then</p><p>MsgBox "Retangulo1 não tem associação."</p><p>Else</p><p>MsgBox "Retangulo1 está associado a '"& Bind.Source & "'"</p><p>MsgBox "Mudando OnValue de " &_</p><p>Bind.OnValue & " para " & Value</p><p>Bind.OnValue = Value</p><p>End If</p><p>ForegroundColor = Value</p><p>End If</p><p>End Sub</p><p>Programando no Elipse E3</p><p>48</p><p>2.8.4.3.5 Associação Múltipla</p><p>Esta seção contém informações sobre os métodos e propriedades do objeto Associação Múltipla (MultiSourceBind).</p><p>Este objeto não possui eventos associados.</p><p>2.8.4.3.5.1 Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Associação Múltipla (MultiSourceBind).</p><p>InsertRow</p><p>InsertRow([InsertAtRow])</p><p>Insere uma nova Linha na tabela de Associações Múltiplas na posição indicada pelo parâmetro InsertAtRow. Este</p><p>parâmetro é opcional e, se omitido, insere a nova Linha ao final da tabela de Associações Múltiplas, o que equivale a</p><p>usar o parâmetro InsertAtRow com o valor -1 (menos um). Se o valor informado em InsertAtRow não é omitido e é</p><p>diferente de -1 (menos um), este valor deve estar entre 1 (um) e Count e a nova Linha criada desloca as Linhas de</p><p>índice maior ou igual para a direção ascendente dos índices.</p><p>Item</p><p>Item(ItemId)</p><p>Retorna uma referência para o objeto Linha da Conexão Múltipla, indicado por ItemId.</p><p>RemoveRow</p><p>RemoveRow(Row)</p><p>Remove a Linha no índice indicado pelo parâmetro Row.</p><p>2.8.4.3.5.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Associação Múltipla (MultiSourceBind).</p><p>AdviseAll</p><p>Esta propriedade mantém todas as Associações da tabela de Associações Múltiplas em modo Advise (ativas). O</p><p>valor padrão desta propriedade é Verdadeiro. Para aplicações criadas em versões anteriores, esta propriedade tem o</p><p>valor Falso, por compatibilidade.</p><p>Count</p><p>Esta propriedade retorna o número de Linhas da tabela de Associações Múltiplas. Esta propriedade é somente de</p><p>leitura.</p><p>2.8.4.3.5.3 Linha da Associação Múltipla</p><p>Esta seção contém informações sobre as propriedades do objeto Linha da Associação Múltipla (MultiSourceRow). Este</p><p>objeto não possui eventos nem métodos associados.</p><p>Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Linha da Associação Múltipla (MultiSourceRow).</p><p>Max</p><p>Esta propriedade especifica o intervalo máximo para o valor da Associação indicada na propriedade Source.</p><p>Min</p><p>Esta propriedade especifica o intervalo mínimo para o valor da Associação indicada na propriedade Source.</p><p>Source</p><p>Esta propriedade especifica a fonte da Associação da Linha da Conexão Múltipla, que pode ser o nome de outro</p><p>objeto da aplicação ou uma expressão mais complexa, acessando vários objetos.</p><p>2.8.4.3.6 Associação por Tabela</p><p>Esta seção contém informações sobre os métodos e propriedades do objeto Associação por Tabela (TableBind). Este</p><p>objeto não possui eventos associados.</p><p>2.8.4.3.6.1 Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Associação por Tabela (TableBind).</p><p>49</p><p>Programando no Elipse E3</p><p>InsertRow</p><p>InsertRow([InsertAtRow])</p><p>Insere uma nova Linha na tabela. O parâmetro InsertAtRow é opcional e especifica em que posição da tabela deve ser</p><p>inserida a Linha. Quando omitido assume o comportamento padrão de inserir a Linha no fim da tabela, o que equivale</p><p>a usar InsertAtRow igual a -1 (menos um). Quando informado e diferente de -1 (menos um), deve ser um valor entre 1</p><p>(um) e Count e a nova Linha criada desloca as Linhas de índice maior ou igual para a direção ascendente dos índices.</p><p>Uma Linha nova sempre assume os seguintes valores padrão para as propriedades:</p><p>· Min: 0.0</p><p>· Max: 1.0</p><p>· Blink: False</p><p>· BlinkValue: 0.0</p><p>· Value: 0.0</p><p>O script a seguir contém um exemplo de uso deste método.</p><p>Sub Retangulo1_Click()</p><p>On Error Resume Next</p><p>Dim Bind</p><p>Set Bind = _</p><p>Screen.Item("Retangulo1").Links.Item("ForegroundColor")</p><p>If Bind Is Nothing Then</p><p>MsgBox "Retangulo1 não tem nenhuma associação."</p><p>Else</p><p>Dim row</p><p>row = Screen.Item("SetPointRow").Value</p><p>MsgBox Bind.RowCount</p><p>If (row < 1 OR row > Bind.RowCount) Then</p><p>MsgBox "Número de linha inválido: " & row</p><p>Else</p><p>MsgBox "Acrescentando uma linha em: " & row</p><p>Bind.InsertRow(row)</p><p>If row = -1 Then</p><p>row = Bind.RowCount</p><p>Bind.Value(line) = _</p><p>Screen.Item("RectangleValue").ForegroundColor</p><p>Bind.BlinkValue(line) = _</p><p>Screen.Item("RectangleBlinkValue").ForegroundColor</p><p>Bind.Max(line) = Screen.Item("SetPointMax").Value</p><p>Bind.Min(line) = Screen.Item("SetPointMin").Value</p><p>Bind.Blink(line) = _</p><p>Screen.Item("CheckBoxBlink").Value</p><p>End If</p><p>End If</p><p>End If</p><p>End Sub</p><p>Item</p><p>Item(ItemId)</p><p>Retorna uma referência para o objeto Linha da Conexão por Tabela, indicado por ItemId.</p><p>RemoveRow</p><p>RemoveRow(Row)</p><p>Remove a Linha no índice especificado. O parâmetro Row determina a Linha da tabela a ser removida e deve estar</p><p>entre 1 (um) e Count. O script a seguir contém um exemplo de uso deste método.</p><p>Sub RemoveRow_Click()</p><p>On Error Resume Next</p><p>Dim Bind</p><p>Set Bind =_</p><p>Screen.Item("Retangulo1").Links.Item("ForegroundColor")</p><p>If Bind Is Nothing Then</p><p>MsgBox "Retangulo1 não tem associação!"</p><p>Else</p><p>MsgBox "Retangulo1 está ligado à '" & Bind.Source & "'"</p><p>Dim row</p><p>row = Screen.Item("Row").Value</p><p>MsgBox "Removendo a linha " & row</p><p>Bind.RemoveRow row</p><p>Programando no Elipse E3</p><p>50</p><p>End If</p><p>End Sub</p><p>2.8.4.3.6.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Associação por Tabela (TableBind).</p><p>Count</p><p>Esta propriedade informa o número de linhas na tabela. Esta propriedade é somente de leitura.</p><p>2.8.4.3.6.3 Linha da Associação por Tabela</p><p>Esta seção contém informações sobre as propriedades do objeto Linha da Associação por Tabela (TableBindRow).</p><p>Este objeto não possui eventos nem métodos associados.</p><p>Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Linha da Associação por Tabela (TableBindRow).</p><p>Blink</p><p>Esta propriedade determina que quando a fonte estiver no intervalo desta Linha, a propriedade alterna</p><p>periodicamente entre os valores especificados nas propriedades Value e BlinkValue. O script a seguir contém um</p><p>exemplo de uso desta propriedade.</p><p>Sub CheckBox1_Click()</p><p>Screen.Item("Retangulo1").Links.Item("ForegroundColor")._</p><p>Item(1).Blink = Value</p><p>Screen.Item("Retangulo1").Links.Item("ForegroundColor")._</p><p>Item(2).Blink = Value</p><p>End Sub</p><p>BlinkValue</p><p>Esta propriedade especifica o valor alternativo (para piscar) da propriedade a ser assumido quando a fonte estiver</p><p>no intervalo especificado na Linha e a propriedade Blink estiver configurada para Verdadeiro. O script a seguir</p><p>contém um exemplo de uso desta propriedade.</p><p>Sub CommandButton1_Click()</p><p>Dim Cor</p><p>' Escolhe uma cor</p><p>Application.ShowPickColor Cor, 0, 100, 100</p><p>Screen.Item("Retangulo1").Links.Item("ForegroundColor")._</p><p>Item(1).BlinkValue = Cor</p><p>End Sub</p><p>Max</p><p>Esta propriedade especifica o valor máximo da fonte para uma Linha da Tabela.</p><p>Min</p><p>Esta propriedade especifica o valor mínimo da fonte para uma Linha da Tabela. O exemplo a seguir se aplica tanto</p><p>para a propriedade Max quanto para Min.</p><p>Sub CommandButton1_Click()</p><p>Set Bind = _</p><p>Screen.Item("Retangulo1").Links.Item("ForegroundColor")</p><p>Set Linha1 = Bind.Item(1)</p><p>Linha1.Min = 0</p><p>Linha1.Max = 20</p><p>Set Linha2 = Bind.Item(2)</p><p>Linha2.Min = 21</p><p>Linha2.Max = 100</p><p>End Sub</p><p>Value</p><p>Esta propriedade especifica o valor da propriedade a ser assumido quando a fonte estiver no intervalo especificado</p><p>na Linha. O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub CommandButton1_Click()</p><p>Dim Cor</p><p>' Escolhe uma cor</p><p>Application.ShowPickColor Cor, 0, 100, 100</p><p>Screen.Item("Retangulo1").Links.Item("ForegroundColor")._</p><p>Item(1).Value = Cor</p><p>End Sub</p><p>51</p><p>Programando no Elipse E3</p><p>2.8.4.3.7 Associação Reversa</p><p>Esta seção contém informações sobre as propriedades do objeto Associação Reversa (AgSimple). Este objeto não</p><p>possui eventos nem métodos associados.</p><p>2.8.4.3.7.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Associação Reversa (AgSimple).</p><p>Reverse</p><p>Esta propriedade retorna Verdadeiro se a Associação é Reversa e retorna Falso se a Associação é Bidirecional ou</p><p>Simples.</p><p>2.8.4.3.8 Associação Simples</p><p>O objeto Associação Simples (AgSimple) não tem eventos, métodos ou propriedades associadas.</p><p>2.8.5 Coleção de Eventos</p><p>Esta seção contém informações sobre os métodos e propriedades do objeto Coleção de Eventos (Events) retornado</p><p>pela propriedade ObjectEvents. Este objeto não possui eventos associados.</p><p>2.8.5.1 Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Coleção de Eventos (Events) retornado pela propriedade</p><p>ObjectEvents.</p><p>2.8.5.1.1 AddUserEvent</p><p>AddUserEvent(Name, [Link], [Type], [ScanTime], [ChangeOnDisconnect])</p><p>Adiciona um Evento de Usuário na Coleção de Eventos e retorna este objeto. Os parâmetros deste método estão</p><p>descritos na tabela a seguir.</p><p>Parâmetros do método AddUserEvent</p><p>PARÂMETRO DESCRIÇÃO</p><p>Name Nome deste Evento de Usuário. Este parâmetro é</p><p>obrigatório</p><p>Link Expressão a ser avaliada neste Evento de Usuário. Este</p><p>parâmetro é opcional e, se omitido, assume o valor de</p><p>uma String vazia. Corresponde à propriedade Link do</p><p>objeto Evento de Usuário</p><p>Type Tipo de Evento de Usuário. Este parâmetro é opcional e,</p><p>se omitido, assume o valor 0 (zero). Corresponde à</p><p>propriedade Type do objeto Evento de Usuário</p><p>ScanTime Tempo, em milissegundos, de repetição deste Evento de</p><p>Usuário. Este parâmetro é opcional e, se omitido, assume</p><p>o valor 1000, ou seja, um segundo. Corresponde à</p><p>propriedade ScanTime do objeto Evento de Usuário</p><p>ChangeOnDisconnect Indica se a desconexão é tratada como mudança no</p><p>valor da expressão deste Evento de Usuário. Este</p><p>parâmetro é opcional e, se omitido, assume o valor 0</p><p>(zero), ou seja, Falso. Corresponde à propriedade</p><p>ChangeOnDisconnect do objeto Evento de Usuário</p><p>2.8.5.1.2 Item</p><p>Item(ItemId)</p><p>Este método retorna um objeto Evento ou Evento de Usuário da Coleção de Eventos de um objeto qualquer do Elipse</p><p>E3. Se este parâmetro é um texto, o parâmetro ItemId especifica o nome do objeto a acessar. O objeto também pode</p><p>ser acessado por um índice numérico. Este índice deve estar entre 1 (um) e Count. Caso o objeto não exista, ou o</p><p>índice seja inválido, ocorre um erro de script.</p><p>Programando no Elipse E3</p><p>52</p><p>2.8.5.1.3 RemoveUserEvent</p><p>RemoveUserEvent(Name)</p><p>Remove um Evento de Usuário, indicado pelo parâmetro Name, da Coleção de Eventos. Este método retorna erro em</p><p>caso de parâmetro inválido.</p><p>2.8.5.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Coleção de Eventos (Events) retornado pela</p><p>propriedade ObjectEvents.</p><p>2.8.5.2.1 Count</p><p>Retorna o número de objetos filhos, ou itens, de uma coleção de Eventos. Esta propriedade trabalha em conjunto</p><p>com o método Item. Se a coleção não possui objetos filhos, o valor retornado é 0 (zero). Esta propriedade é somente</p><p>de leitura.</p><p>2.8.5.3 Evento</p><p>Esta seção contém informações sobre os métodos e propriedades do objeto Evento (Event) da Coleção de Eventos.</p><p>Este objeto não possui eventos associados.</p><p>2.8.5.3.1 Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Evento (Event) da Coleção de Eventos.</p><p>2.8.5.3.1.1 AddScript</p><p>AddScript(bstrCode)</p><p>Adiciona um Pick do tipo Executar Script a este Evento com o código especificado no parâmetro bstrCode. Este</p><p>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</p><p>String vazia.</p><p>2.8.5.3.1.2 RemoveAll</p><p>RemoveAll()</p><p>Remove todos os Picks do tipo Executar Script deste Evento. Este método não retorna erro caso não haja Picks neste</p><p>Evento.</p><p>2.8.5.3.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Evento (Event) da Coleção de Eventos.</p><p>2.8.5.3.2.1 Name</p><p>Retorna o nome deste Evento na Coleção de Eventos. Esta propriedade é somente de leitura.</p><p>2.8.5.4 Evento de Usuário</p><p>Esta seção contém informações sobre os métodos e propriedades do objeto Evento de Usuário (UserEvent) da</p><p>Coleção de Eventos. Este objeto não possui eventos associados.</p><p>2.8.5.4.1 Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Evento de Usuário (UserEvent) da Coleção de Eventos.</p><p>2.8.5.4.1.1 AddScript</p><p>AddScript(bstrCode)</p><p>Adiciona um script a este Evento de Usuário com o código especificado no parâmetro bstrCode. Este parâmetro deve</p><p>conter apenas o corpo do script, sem a linha inicial Sub e sem a linha final End Sub, e pode ser uma String vazia.</p><p>53</p><p>Programando no Elipse E3</p><p>2.8.5.4.1.2 RemoveAll</p><p>RemoveAll()</p><p>Remove todos os scripts deste Evento de Usuário. Este método não retorna erro caso não haja scripts neste Evento</p><p>de Usuário.</p><p>2.8.5.4.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Evento de Usuário (UserEvent) da Coleção de</p><p>Eventos.</p><p>2.8.5.4.2.1 ChangeOnDisconnect</p><p>Indica se uma desconexão é tratada como uma alteração no valor da expressão indicada na propriedade Link. Esta</p><p>propriedade somente se aplica a Eventos de Usuário cuja propriedade Type seja igual a 2 (dois,</p><p>uetOnValueChanged). O valor padrão desta propriedade é Falso.</p><p>2.8.5.4.2.2 Link</p><p>Texto com a expressão avaliada no Evento de Usuário. O valor padrão desta propriedade é uma String vazia.</p><p>2.8.5.4.2.3 ScanTime</p><p>Tempo, em milissegundos, referente ao período de repetição deste Evento de Usuário. Esta propriedade somente</p><p>se aplica a Eventos de Usuário cuja propriedade Type seja igual a 1 (um, uetWhileTrue). O valor padrão desta</p><p>propriedade é 1000, ou um segundo.</p><p>2.8.5.4.2.4 Type</p><p>Indica o tipo de Evento de Usuário. Os valores possíveis para esta propriedade são 0 - uetOnEvent: o Evento de</p><p>Usuário dispara quando o valor da expressão muda de Falso para Verdadeiro (padrão), 1 - uetWhileTrue: o Evento</p><p>de Usuário dispara periodicamente enquanto o valor da expressão é igual a Verdadeiro ou 2 - uetOnValueChanged:</p><p>o Evento de Usuário dispara quando o valor da expressão é alterado.</p><p>Bibliotecas do Usuário</p><p>54</p><p>3</p><p>Bibliotecas do Usuário</p><p>CAPÍTULO</p><p>Esta seção contém informações sobre os objetos ElipseX (XControls, XFolders e XObjects).</p><p>3.1 ElipseX</p><p>Esta seção contém informações sobre eventos e propriedades comuns aos objetos ElipseX (XControls, XFolders e</p><p>XObjects). Estes objetos não possuem métodos comuns associados.</p><p>3.1.1 Eventos Comuns</p><p>Esta seção contém informações sobre os eventos comuns aos objetos ElipseX (XControls, XFolders e XObjects).</p><p>3.1.1.1 Constructor</p><p>Constructor()</p><p>Disparado quando o ElipseX é iniciado. Pode-se utilizar este evento para executar um script que inicie valores internos</p><p>de um ElipseX, por exemplo.</p><p>3.1.1.2 CustomConfig</p><p>CustomConfig()</p><p>Permite configurações automatizadas nas instâncias de objetos ElipseX. Uma opção de configuração aparece no menu</p><p>contextual das instâncias de objetos</p><p>ElipseX sempre que existir um script associado a este evento da definição do</p><p>objeto ElipseX. Quando esta opção é selecionada no menu contextual, o evento é disparado. O texto que aparece na</p><p>opção do menu contextual pode ser informado na propriedade CustomConfigText da definição do objeto ElipseX.</p><p>Se esta propriedade estiver em branco, aparece o texto "Configurar".</p><p>55</p><p>Bibliotecas do Usuário</p><p>Menu contextual da instância do objeto ElipseX</p><p>NOTA</p><p>O script associado a este evento executa no Elipse E3 Studio, onde os objetos não estão ativos. Portanto, o</p><p>comportamento é diferente do usual.</p><p>3.1.2 Propriedades Comuns</p><p>Esta seção contém informações sobre as propriedades comuns aos objetos ElipseX (XControls, XFolders e XObjects).</p><p>3.1.2.1 Contexts</p><p>Define uma variável de contexto usada em expressões de Associações. Para mais informações sobre contextos, veja</p><p>o método Context no tópico Eventos, Métodos e Propriedades Gerais dos Objetos.</p><p>NOTA</p><p>O valor desta propriedade não permite caracteres especiais, apenas letras (sem diferenciar maiúsculas e minúsculas)</p><p>e números.</p><p>Bibliotecas do Usuário</p><p>56</p><p>3.1.2.2 CustomConfigText</p><p>Indica o texto que deve aparecer no menu contextual para a opção de configuração da instância do ElipseX. A</p><p>opção só aparece se existir um script associado ao evento CustomConfig da definição do ElipseX. Se o valor da</p><p>propriedade estiver em branco, aparece o texto "Configurar" na opção do menu contextual. O valor padrão desta</p><p>propriedade é uma String vazia.</p><p>3.1.2.3 DefaultIsAlarmArea</p><p>Define o comportamento de habilitar ou não a propriedade IsAlarmArea nas instâncias do ElipseX.</p><p>NOTA</p><p>Esta propriedade não está disponível para XControls.</p><p>3.1.2.4 EnableTagBehavior</p><p>Esta propriedade permite habilitar um comportamento de Tag a uma instância do ElipseX, ou seja, se a instância</p><p>contém pelo menos as propriedades Value, Quality e Timestamp, os valores destas propriedades são sempre</p><p>propagados em conjunto. O valor padrão desta propriedade é Falso. Ao habilitar esta propriedade, o Elipse E3</p><p>Studio verifica se o ElipseX contém todas as propriedades obrigatórias, Value (do tipo Variant), Quality (do tipo</p><p>Word) e Timestamp (do tipo Date). As propriedades a seguir são opcionais e também podem ser criadas durante o</p><p>processo de verificação:</p><p>· ActiveSource (fonte de medida ativa, do tipo PowerSourceType)</p><p>· EU (unidade de engenharia, do tipo String)</p><p>· EULow (valor mínimo da propriedade Value, do tipo Double)</p><p>· EUHigh (valor máximo da propriedade Value, do tipo Double)</p><p>NOTA</p><p>· Se alguma das propriedades obrigatórias para o funcionamento do comportamento de Tag (Value, Quality ou</p><p>Timestamp) é apagada, isto impede o uso do ElipseX em tempo de execução.</p><p>· Da mesma forma, alterar o tipo de dados das propriedades (obrigatórias ou opcionais) para um tipo de dados</p><p>incompatível também impede o uso do ElipseX em tempo de execução.</p><p>· Configurar esta propriedade em Verdadeiro habilita o comportamento da propriedade ValueMode.</p><p>3.1.2.5 FriendlyName</p><p>Define um nome amigável para a classe do ElipseX, utilizado no menu contextual de inserção de objetos e na janela</p><p>Contagem de Objetos do Domínio.</p><p>3.1.2.6 IconPath</p><p>Define o nome do arquivo de imagem a ser utilizado como ícone para as instâncias do ElipseX. Este ícone é</p><p>mostrado no menu contextual Inserir de Telas (para XControls) e Servidores de Dados (para XFolders e XObjects),</p><p>bem como no Organizer, AppBrowser, etc. Esta propriedade permite arrastar e soltar um arquivo de imagem inserido</p><p>como Recurso no projeto. O valor padrão desta propriedade é uma String vazia, ou seja, a instância do ElipseX</p><p>mostra o ícone para XControls, o ícone para XFolders e o ícone para XObjects.</p><p>3.1.2.7 InstanceName</p><p>Define um nome padrão para as instâncias criadas a partir do ElipseX. Consulte a propriedade geral Name para</p><p>mais informações sobre os caracteres permitidos no nome desta instância.</p><p>3.1.2.8 ValueMode</p><p>Esta propriedade informa se as instâncias de um ElipseX possuem valores analógicos, discretos ou não definidos.</p><p>Os valores possíveis para esta propriedade são 0: vmUndefined (valor padrão), 1: vmAnalog ou 2: vmDiscrete. Esta</p><p>propriedade somente tem efeito se a propriedade EnableTagBehavior estiver configurada em Verdadeiro.</p><p>57</p><p>Bibliotecas do Usuário</p><p>3.1.3 Objeto Definição de Propriedades</p><p>Esta seção contém informações sobre eventos e propriedades do objeto Definição de Propriedades (XMethod). Este</p><p>objeto não possui métodos associados.</p><p>3.1.3.1 Eventos</p><p>Esta seção contém informações sobre os eventos do objeto Definição de Propriedades (XMethod).</p><p>3.1.3.1.1 OnPropertyChanged</p><p>OnPropertyChanged()</p><p>Ocorre quando uma Definição de Propriedade de um ElipseX é modificada. Pode-se utilizar este evento para disparar</p><p>scripts que executem ações de acordo com determinado status de um ElipseX.</p><p>3.1.3.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Definição de Propriedades (XMethod).</p><p>3.1.3.2.1 DefaultValue</p><p>Define o valor inicial para a Definição de Propriedade quando uma nova instância do objeto é criada. Se a Definição</p><p>de Propriedade está configurada como retentiva, ela é inicializada com este valor cada vez que o objeto é carregado.</p><p>O valor padrão desta propriedade é vazio (empty).</p><p>3.1.3.2.2 ExposableToOpc</p><p>Indica como uma Definição de Propriedade é exposta no Servidor OPC UA. Os valores possíveis para esta</p><p>propriedade são 0 - eDontExpose: Esta Definição de Propriedade não é exposta no Servidor OPC UA, 1 - eExpose:</p><p>Esta Definição de Propriedade é exposta no Servidor OPC UA para leitura e escrita ou 2 - eExposeAsReadOnly: Esta</p><p>Definição de Propriedade é exposta no Servidor OPC UA somente para leitura.</p><p>3.1.3.2.3 HelpString</p><p>Texto contendo a descrição da Definição de Propriedade. Este texto é mostrado na parte inferior da Lista de</p><p>Propriedades no Elipse E3 Studio quando a Definição de Propriedade é selecionada. O valor padrão desta</p><p>propriedade é uma String vazia.</p><p>3.1.3.2.4 Persistable</p><p>Indica se a Definição de Propriedade é salva no arquivo de projeto (Verdadeiro) ou se está disponível apenas em</p><p>tempo de execução (Falso). O valor padrão desta propriedade é Verdadeiro. Se esta propriedade é configurada com</p><p>o valor Falso, a Definição de Propriedade não pode ser editada no Elipse E3 Studio, nem salva ou lida do arquivo de</p><p>projeto. Entretanto, a Definição de Propriedade ainda é visível no AppBrowser. Esta propriedade é representada pelo</p><p>ícone .</p><p>Quando esta propriedade está configurada para Verdadeiro, a Definição de Propriedade recebe seu valor padrão</p><p>(propriedade DefaultValue) apenas na criação de uma instância. Se a propriedade DefaultValue é alterada, as</p><p>instâncias do objeto já criadas não são afetadas.</p><p>Quando esta propriedade está configurada para Falso, a Definição de Propriedade recebe seu valor padrão sempre</p><p>que uma instância é carregada, ou seja, sempre que a propriedade DefaultValue é alterada, todas as instâncias já</p><p>criadas são inicializadas com o novo valor padrão.</p><p>3.1.3.2.5 Public</p><p>Quando uma Definição de Propriedade de um ElipseX é pública (Verdadeiro), ela é visível fora da Biblioteca. Caso</p><p>contrário, a Definição de Propriedade é interna e somente visível para o objeto. O valor padrão desta propriedade é</p><p>Verdadeiro. A Definição de Propriedade pública é representada pelo ícone .</p><p>3.1.3.2.6 Retentive</p><p>Indica se o valor atual da Definição de Propriedade em tempo de execução é persistido no arquivo de Domínio</p><p>(Verdadeiro), enquanto o Domínio estiver carregado. Uma Definição de Propriedade retentiva é representada pelo</p><p>ícone . Definições de Propriedade retentivas têm o seguinte comportamento:</p><p>· Propagam o seu valor para o servidor em Standby</p><p>Bibliotecas do Usuário</p><p>58</p><p>· Mantêm o seu valor se a aplicação é atualizada em tempo de execução</p><p>· Mantém o seu valor se a aplicação é parada (desde que o Domínio não seja fechado)</p><p>NOTAS</p><p>· Esta propriedade somente está disponível para Definições de Propriedades cujo tipo de dados não seja um</p><p>objeto, como por exemplo Variant, Double ou Integer.</p><p>· O uso desta propriedade em Verdadeiro implica em um aumento no uso de memória e CPU por parte do E3Run,</p><p>por isto deve ser utilizada com cautela.</p><p>3.1.3.2.7 Type</p><p>Determina o tipo de valores que a Definição de Propriedade aceita (por exemplo, Boolean, Double, Integer,</p><p>Variant, etc.). Quando é especificado um objeto como tipo (por exemplo DemoTag, IOTag, XObject, etc.), esta</p><p>propriedade tem o seguinte comportamento:</p><p>· Caso o ElipseX esteja inativo: A propriedade funciona como uma String, que especifica o caminho da instância</p><p>de um objeto do tipo configurado</p><p>· Caso o ElipseX esteja ativo: Na escrita, a propriedade funciona da mesma maneira de quando o objeto está</p><p>desativado. Porém, na leitura a propriedade retorna o objeto especificado, caso exista. Se o caminho não aponta</p><p>para um objeto existente no momento, a propriedade retorna Nothing</p><p>59</p><p>Visualização</p><p>4</p><p>Visualização</p><p>CAPÍTULO</p><p>Esta seção contém informações sobre eventos, métodos e propriedades dos objetos de visualização do Elipse E3:</p><p>· Viewer</p><p>· Quadros e Divisores</p><p>· Telas e Objetos de Tela</p><p>· E3Alarm</p><p>· E3Browser</p><p>· E3Chart</p><p>· E3Playback</p><p>· Relatório de Seção</p><p>· TrendAnalysis</p><p>4.1 Viewer</p><p>Esta seção contém informações sobre eventos, métodos e propriedades do objeto Viewer.</p><p>4.1.1 Eventos</p><p>Esta seção contém informações sobre os eventos do objeto Viewer.</p><p>4.1.1.1 OnInactive</p><p>OnInactive()</p><p>Este evento ocorre enquanto o Elipse E3 Viewer está inativo e se a propriedade EnableInactivity está configurada</p><p>em Verdadeiro. Este evento inicia quando se constata que o usuário está sem utilizar o Elipse E3 Viewer por um</p><p>período de tempo igual ou superior ao valor da propriedade InactivityTime.</p><p>Em um script para este evento, o usuário pode programar uma ação quando o Elipse E3 Viewer está inativo por um</p><p>determinado período de tempo. Por exemplo, é possível determinar que após 20 minutos sem uso seja efetuado o</p><p>logout do Elipse E3 Viewer, como no exemplo a seguir.</p><p>Sub Viewer_OnInactive()</p><p>Logout(false)</p><p>If MsgBox("Essa sessão do Elipse E3 Viewer foi fechada_</p><p>devido à inatividade.") = 0 Then</p><p>Application.GetFrame("").OpenScreen "TelaInicial", 0</p><p>End Sub</p><p>4.1.1.2 Eventos de Usuário</p><p>Esta seção contém informações sobre eventos de usuário do objeto Viewer.</p><p>4.1.1.2.1 OnLogin</p><p>OnLogin()</p><p>Ocorre quando um usuário executa um login na aplicação, ou autenticação de usuário, com sucesso. O login na</p><p>aplicação pode ser executado através do método Login ou quando um objeto que só pode ser acessado por</p><p>usuários com um determinado nível de autorização exige autenticação.</p><p>4.1.1.2.2 OnLogout</p><p>OnLogout()</p><p>Ocorre quando é executado um logout, ou seja, a saída do usuário de uma aplicação. O logout é realizado através da</p><p>chamada ao método Logout.</p><p>4.1.2 Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Viewer.</p><p>Visualização</p><p>60</p><p>4.1.2.1 CaptureScreen</p><p>CaptureScreen(FileName)</p><p>Este método captura a Tela atual e a salva em um arquivo. Este método é semelhante ao efeito realizado pela tecla</p><p>PRINT SCREEN no Windows. O parâmetro FileName determina o nome do arquivo no qual a Tela é salva.</p><p>NOTA</p><p>O formato final do arquivo é Bitmap, um arquivo com a extensão .bmp, mesmo que no parâmetro FileName seja</p><p>informada outra extensão, como por exemplo .gif ou .jpg.</p><p>O código a seguir contém um exemplo de uso deste método.</p><p>Sub CommandButton1_Click()</p><p>Screen.Frame.CaptureScreen "c:\temp\tela.bmp"</p><p>End Sub</p><p>4.1.2.2 ChangePassword</p><p>ChangePassword([PosX], [PosY])</p><p>Este método abre uma caixa de diálogo para permitir a troca de senha do usuário atual e retorna Verdadeiro se o</p><p>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</p><p>trocar a senha porque o usuário não tem autorização.</p><p>Este método tem os parâmetros opcionais PosX, que indica a posição em pixels da caixa de diálogo em relação à</p><p>margem esquerda da janela, e PosY, que indica a posição em pixels da caixa de diálogo em relação à margem</p><p>superior da janela. Caso algum destes parâmetros seja omitido, a respectiva coordenada da caixa de diálogo é</p><p>centralizada na janela. Caso os valores indicados nestes parâmetros posicionem a caixa de diálogo fora da área visível</p><p>da janela, estes valores são ajustados automaticamente para garantir que a caixa de diálogo esteja visível.</p><p>NOTAS</p><p>· Este método só está disponível se o usuário logado é um usuário do Domínio do Elipse E3.</p><p>· Sempre que o usuário atual troca a senha, é realizado um logout de todas as sessões onde este usuário estava</p><p>logado, exceto da sessão onde foi realizada a troca de senha.</p><p>4.1.2.3 ChangeUserPassword</p><p>ChangeUserPassword(Username, PasswordOld, PasswordNew, [OpStatus])</p><p>Este método permite alterar a senha de um usuário sem mostrar nenhuma mensagem. O parâmetro Username é o</p><p>nome do usuário, o parâmetro PasswordOld é a senha atual deste usuário e o parâmetro PasswordNew é a nova senha.</p><p>O parâmetro opcional de retorno OpStatus é um mapa de bits que indica o status desta operação. Este método</p><p>retorna um Booleano indicando se a operação falhou ou não. Consulte a tabela Valores de retorno possíveis para o</p><p>parâmetro OpStatus no método LoginUser para mais informações sobre os valores possíveis em caso de falha.</p><p>NOTA</p><p>Sempre que um usuário troca a senha, é realizado um logout de todas as sessões onde este usuário estava logado,</p><p>exceto da sessão onde foi realizada a troca de senha.</p><p>4.1.2.4 DoModal</p><p>DoModal(Screen, Title, Left, Top, Width, Height, Arg, [Flags])</p><p>Abre uma Tela modal, que é uma janela que não permite clicar em outras Telas ou janelas enquanto não é fechada. O</p><p>parâmetro Title passado neste método só é utilizado se a propriedade Caption está vazia. Do contrário, este</p><p>parâmetro é ignorado. Este método possui os seguintes parâmetros:</p><p>· Screen: Determina o nome da Tela</p><p>· Title: Determina o título da janela modal</p><p>· Left, Top: Posição XY da janela modal, em pixels</p><p>· Width: Largura da janela modal, em pixels ou Himetric</p><p>· Height: Altura da janela modal, em pixels ou Himetric</p><p>61</p><p>Visualização</p><p>· Arg: Determina a variável a ser usada no evento OnPreShow da Tela</p><p>· Flags: Determina a combinação utilizada na janela modal. Tal combinação é realizada somando-se os valores da</p><p>tabela correspondentes às opções que o usuário deseja. Quando o valor especificado é igual a -1 (menos um,</p><p>usado quando o parâmetro e omitido), são adotadas as configurações do Viewer para a janela modal. Quando</p><p>este valor é diferente de -1 (menos um), pode-se usar as combinações descritas na tabela a seguir</p><p>Combinações possíveis para o parâmetro Flags</p><p>VALOR DESCRIÇÃO</p><p>1 Habilita a barra de título na janela</p><p>2 Habilita o botão Fechar na janela</p><p>4 Habilita o botão Minimizar na janela</p><p>8 Habilita o botão Maximizar na janela</p><p>16 Habilita a borda na janela</p><p>32 Especifica que a janela pode ser dimensionada</p><p>64 Especifica que a janela pode ser movida</p><p>256 Especifica que a janela permanece no topo da Tela</p><p>512 Especifica que a janela é configurada no estilo Barra de</p><p>Ferramentas</p><p>1024 Desabilita os botões de objeto</p><p>2048 Centraliza</p><p>a Tela modal no Quadro, tanto horizontal</p><p>quanto verticalmente</p><p>O código a seguir contém um exemplo de uso deste método.</p><p>Sub Botao1_Click()</p><p>' Ao clicar no Botão, abre uma outra Tela modal</p><p>Application.DoModal "Tela1", "Titulo", 0, 0, 400, 200, 0, 3</p><p>End Sub</p><p>NOTA</p><p>Os valores de tamanho neste método podem ser informados como números ou Strings. No caso de números, são</p><p>considerados em pixels. No caso de Strings, se vierem acompanhados da unidade "hm", são interpretados como</p><p>Himetric. Qualquer outro caso é considerado em pixels.</p><p>4.1.2.5 ESign</p><p>ESign(ObjName, [Description], [Action], [From], [To], [User], [Comment])</p><p>Este método é utilizado para validar a alteração de um campo através de assinatura eletrônica. Quando este método</p><p>é utilizado, a caixa de diálogo da figura a seguir é mostrada.</p><p>Visualização</p><p>62</p><p>Caixa de Diálogo de Assinatura Eletrônica</p><p>Parâmetros do método ESign</p><p>PARÂMETRO DESCRIÇÃO</p><p>ObjName Texto que contém o nome de um Tag ou outro objeto da</p><p>aplicação</p><p>Description Texto que contém a descrição de ObjName. Este</p><p>parâmetro é opcional e, se omitido, a caixa de diálogo</p><p>tenta buscar os dados da propriedade DocString de</p><p>ObjName</p><p>Action Texto que contém a ação a ser executada, como por</p><p>exemplo "Alteração do valor". Este parâmetro é opcional</p><p>e, se omitido, insere uma String vazia no campo Ação</p><p>From Variant que contém o valor original ou o estado a ser</p><p>alterado. Este parâmetro é opcional e, se omitido, insere</p><p>uma String vazia no campo De</p><p>To Variant que contém o novo valor do Tag ou o valor a</p><p>ser aplicado em Action. Este parâmetro é opcional e, se</p><p>omitido, insere uma String vazia no campo Para</p><p>User Texto de retorno. Recebe o nome de login selecionado</p><p>na caixa de diálogo. Este parâmetro é opcional e, se</p><p>omitido, insere uma String vazia no campo Usuário</p><p>Comment Texto de retorno. Recebe o comentário digitado na caixa</p><p>de diálogo. Este parâmetro é opcional e, se omitido,</p><p>insere uma String vazia no campo Comentário</p><p>Ao clicar em , abre-se uma janela que permite autenticar o usuário. Se a opção Windows é selecionada, os campos</p><p>Nome do usuário e Senha são automaticamente desabilitados. Clique em Outro usuário para selecionar um usuário</p><p>pertencente ao domínio de rede. Caso a opção E3 seja selecionada, digite as informações de um usuário pertencente</p><p>ao Domínio do Elipse E3 nos campos Nome do usuário e Senha.</p><p>63</p><p>Visualização</p><p>Login integrado</p><p>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</p><p>contrário, se a caixa de diálogo é cancelada ou se o login ou a senha estiverem errados, após três tentativas o</p><p>método retorna Falso. Em caso de falha, User e Comment são configurados para uma String vazia.</p><p>Os comentários pré-definidos são armazenados no Registro do Windows. Apenas os últimos 26 comentários são</p><p>salvos. Cada vez que a janela é criada, os últimos comentários são buscados no Registro e usados para preencher a</p><p>lista de seleção. Se um novo comentário é informado pelo usuário, este é salvo e o mais antigo é descartado, caso</p><p>não haja posição livre. Se um comentário já existente é utilizado, este passa a ser o primeiro da lista de comentários</p><p>mais recentes. O código a seguir contém um exemplo de uso deste método.</p><p>Sub Button1_Click()</p><p>Dim Tag, User, Comment</p><p>Set Tag = Application.GetObject("IO.Inputs.I001")</p><p>If Application.ESign(Tag.PathName, , "Alteração do Valor", _</p><p>Tag.Value, 1, User, Comment) Then</p><p>If Tag.WriteEx(1) Then</p><p>Application.TrackEvent _</p><p>"Tag IO.Inputs.I001 alterado para 1 " &_</p><p>"pelo usuário" & User, Comment</p><p>End If</p><p>End If</p><p>End Sub</p><p>4.1.2.6 ExecuteExternalApp</p><p>ExecuteExternalApp(AppPath, Arguments, InitialDir, CmdShow, [ProcessId])</p><p>Este método executa uma aplicação externa de nome e caminho indicado no parâmetro AppPath, com os argumentos</p><p>indicados pelo parâmetro Arguments, iniciando no diretório de trabalho indicado pelo parâmetro InitialDir. Quando</p><p>especificado um documento no parâmetro AppPath, a aplicação associada a este documento é executada e o</p><p>documento é passado como um dos parâmetros da aplicação. O parâmetro ProcessID é opcional e recebe o número</p><p>que identifica o processo da aplicação externa no sistema operacional. Este número é utilizado no método</p><p>IsAppRunning e é o mesmo valor que aparece no Gerenciador de Tarefas do Windows, na coluna PID. O parâmetro</p><p>CmdShow especifica o modo de abertura da janela da aplicação, conforme descrito na tabela a seguir.</p><p>Opções disponíveis para o parâmetro CmdShow</p><p>OPÇÃO DESCRIÇÃO</p><p>0 Esconde a janela e ativa outra janela</p><p>1 Ativa e mostra a janela. Se a janela estiver maximizada ou</p><p>minimizada, ela é restaurada para o tamanho e posição</p><p>originais. Uma aplicação deve especificar este valor</p><p>quando estiver mostrando uma janela pela primeira vez</p><p>2 Ativa a janela e mostra-a minimizada</p><p>3 Ativa a janela e mostra-a maximizada</p><p>4 Mostra a janela com seu tamanho e posição mais</p><p>recentes. A janela ativa permanece ativa</p><p>Visualização</p><p>64</p><p>OPÇÃO DESCRIÇÃO</p><p>5 Ativa a janela e mostra-a com seu tamanho e posição</p><p>atuais</p><p>6 Minimiza a janela e ativa a próxima janela de nível</p><p>superior</p><p>7 Mostra a janela minimizada. A janela ativa permanece</p><p>ativa</p><p>8 Mostra a janela em seu estado atual. A janela ativa</p><p>permanece ativa</p><p>9 Ativa e mostra a janela. Se a janela estiver maximizada ou</p><p>minimizada, ela é restaurada para o tamanho e posição</p><p>originais. Uma aplicação deve especificar este valor</p><p>quando estiver restaurando uma janela que estava</p><p>minimizada</p><p>O código a seguir contém um exemplo de uso deste método.</p><p>Sub CommandButton1_Click()</p><p>Dim ret</p><p>Application.ExecuteExternalApp "calc.exe", "", "", 1, ret</p><p>Application.GetObject("Dados.TagInterno1").Value = ret</p><p>End Sub</p><p>NOTA</p><p>O parâmetro retornado em ProcessID pode ser 0 (zero), caso nenhum processo tenha sido iniciado. Por exemplo, se</p><p>um documento aberto é uma URL e uma instância do Internet Explorer já está em execução, esta instância mostra o</p><p>documento. Nenhum processo novo é iniciado, portanto ProcessID é 0 (zero).</p><p>4.1.2.7 Exit</p><p>Exit()</p><p>Este método fecha a janela do Elipse E3 Viewer. O código a seguir contém um exemplo de uso deste método.</p><p>Sub_Botao1.Click()</p><p>Application.Exit()</p><p>EndSub</p><p>4.1.2.8 GetFormulaUnitDataObj</p><p>GetFormulaUnitDataObj(FormulaName)</p><p>Este método obtém a configuração das Unidades existentes em uma determinada Fórmula. As Unidades são o destino</p><p>dos dados salvos na Fórmula, ou valores. Este método possui o parâmetro FormulaName, que é o nome da Fórmula.</p><p>Utilize este método para obter uma coleção das Unidades de uma Fórmula. Este método retorna Verdadeiro se</p><p>conseguir realizar a operação ou Falso, caso não consiga. O código a seguir contém um exemplo de uso deste</p><p>método.</p><p>Sub Botao1_Click()</p><p>Dim val</p><p>' Quando clica no botão, mostra uma caixa de</p><p>' mensagem(MessageBox) com o número de Units</p><p>' e o nome da primeira Unit</p><p>Set obj = Application.GetFormulaUnitDataObj("Formula1")</p><p>MsgBox CStr(obj.Count)</p><p>MsgBox CStr(obj.Name(1))</p><p>End Sub</p><p>4.1.2.9 GetFormulaValueDataObj</p><p>GetFormulaValueDataObj(FormulaName)</p><p>Este método obtém a configuração dos valores existentes em uma determinada Fórmula. Os valores são o conjunto</p><p>de dados salvos na Fórmula. Este método possui o parâmetro FormulaName, que é o nome da Fórmula.</p><p>Utilize este método para obter uma coleção de valores na Fórmula. Este método retorna Verdadeiro se conseguir</p><p>realizar a operação ou Falso, caso não consiga. O código a seguir contém um exemplo de uso deste método.</p><p>65</p><p>Visualização</p><p>Sub Botao1_Click()</p><p>Dim val</p><p>' Quando clica no botão, mostra uma caixa de mensagem</p><p>' (MessageBox) com o número de Conjuntos</p><p>' e o nome do Primeiro Conjunto.</p><p>Set obj = Application.GetFormulaValueDataObj("Formula1")</p><p>MsgBox CStr(Obj.Count)</p><p>MsgBox CStr(obj.Name(1))</p><p>End Sub</p><p>4.1.2.10 GetFrame</p><p>GetFrame([FrameName], [CreateNew])</p><p>Este método procura por um objeto Divisor que já esteja aberto no Elipse E3 Viewer atual. Este método possui os</p><p>parâmetros FrameName, que é opcional e determina o nome do Quadro a ser buscado, e CreateNew, que também é</p><p>opcional e determina se é necessário criar uma nova janela caso o Quadro não seja encontrado. Caso o valor</p><p>especificado em FrameName seja omitido ou uma String vazia, retorna um Quadro que contém todos os Divisores ou</p><p>a Tela ativa no momento. Caso o parâmetro CreateNew seja omitido ou configurado como Verdadeiro, uma nova</p><p>janela é criada. Com o retorno deste método, utilize os métodos do Divisor, como por exemplo o método</p><p>OpenScreen, para abrir uma outra Tela. O código a seguir contém um exemplo de uso deste método.</p><p>Sub Botao1_Click()</p><p>' Ao clicar neste Botão, recebe o Quadro 'Menu'</p><p>' e substitui a Tela atual deste Quadro pela Tela 'Opções'</p><p>Set novoQuadro = Application.GetFrame("Menu")</p><p>' novoQuadro possui um objeto do tipo Divisor</p><p>novoQuadro.OpenScreen "Opções", 0</p><p>End Sub</p><p>NOTA</p><p>Caso o nome passado no parâmetro FrameName se refira a um Quadro não existente e o parâmetro CreateNew seja</p><p>configurado como Falso, este método retorna Nothing, ou seja, não retorna nenhum Quadro.</p><p>4.1.2.11 GetFullUserName</p><p>GetFullUserName()</p><p>Este método retorna o nome completo do usuário logado no Elipse E3. Caso não haja nenhum usuário logado,</p><p>retorna uma String vazia.</p><p>4.1.2.12 GetKeyPad</p><p>GetKeyPad()</p><p>Retorna uma referência para o objeto Elipse KeyPad, permitindo manipular um teclado virtual flutuante em aplicações</p><p>desenvolvidas com o Elipse E3. Consulte o Manual do Usuário do Elipse E3 para mais informações sobre este</p><p>objeto. Os métodos e propriedades do Elipse KeyPad estão descritos no capítulo ActiveX - Elipse KeyPad.</p><p>4.1.2.13 GetMouseX</p><p>GetMouseX()</p><p>Retorna a coordenada X do ponteiro do mouse, em pixels, referente à área total da tela do computador.</p><p>NOTA</p><p>Este método falha em um script se a posição atual do ponteiro do mouse não pode ser determinada. Uma das</p><p>situações onde esta falha pode ser verificada é o caso de estar aberta a janela de Logon do Windows, ou seja, ao</p><p>pressionar o atalho de teclado CTRL + ALT + DEL. Este comportamento de impedir o acesso à posição atual do</p><p>ponteiro do mouse é padrão do Windows em algumas situações e não pode ser contornado. Sugere-se utilizar a</p><p>instrução On Error Resume Next antes da utilização deste método, para evitar erros de script.</p><p>4.1.2.14 GetMouseY</p><p>GetMouseY()</p><p>Retorna a coordenada Y do ponteiro do mouse, em pixels, referente à área total da tela do computador.</p><p>Visualização</p><p>66</p><p>NOTA</p><p>Este método falha em um script se a posição atual do ponteiro do mouse não pode ser determinada. Uma das</p><p>situações onde esta falha pode ser verificada é o caso de estar aberta a janela de Logon do Windows, ou seja, ao</p><p>pressionar o atalho de teclado CTRL + ALT + DEL. Este comportamento de impedir o acesso à posição atual do</p><p>ponteiro do mouse é padrão do Windows em algumas situações e não pode ser contornado. Sugere-se utilizar a</p><p>instrução On Error Resume Next antes da utilização deste método, para evitar erros de script.</p><p>4.1.2.15 GetScreen</p><p>GetScreen(ScreenName)</p><p>Este método retorna um objeto Tela, cujo nome deve ser especificado no parâmetro ScreenName. O valor de retorno</p><p>deste método pode ser utilizado no método ShowScreen do objeto Divisor.</p><p>4.1.2.16 GetTrendAnalysis</p><p>GetTrendAnalysis([Title])</p><p>Retorna um objeto que permite configurar a janela do TrendAnalysis. O parâmetro Title indica um título, opcional, para</p><p>a janela do TrendAnalysis. Caso este parâmetro seja omitido, a janela do TrendAnalysis recebe a expressão</p><p>"TrendAnalysis". Em um script, deve-se utilizar este método conforme o código a seguir.</p><p>Sub</p><p>Set TA = Application.GetTrendAnalysis("TrendAnalysis Window")</p><p>End Sub</p><p>Para mais informações sobre propriedades e métodos deste objeto, consulte o tópico TrendAnalysis.</p><p>4.1.2.17 GetValue</p><p>GetValue(TagName)</p><p>Este método busca pelo valor de um objeto especificado no parâmetro TagName. Se TagName apontar para uma</p><p>propriedade, este método retorna o valor da propriedade. Se por outro lado o parâmetro TagName especificar um</p><p>objeto, o método retorna o valor da propriedade Value do objeto. O código a seguir contém um exemplo de uso</p><p>deste método.</p><p>Sub Botao1_Click()</p><p>' Ao clicar no Botão,</p><p>' recupera o valor de um Tag</p><p>' sendo executado em um Servidor de Dados</p><p>X = Application.GetValue("Dados1.TagInterno1")</p><p>End Sub</p><p>4.1.2.18 IsAppRunning</p><p>IsAppRunning(ProcessId)</p><p>Indica se uma aplicação iniciada pelo método ExecuteExternalApp está em execução. Retorna Verdadeiro se a</p><p>aplicação identificada no sistema operacional por ProcessId está em execução. Caso contrário, retorna Falso. O código</p><p>a seguir contém um exemplo de uso deste método.</p><p>Sub CommandButton1_Click()</p><p>Application.ExecuteExternalApp _</p><p>"www.elipse.com.br", "", "", 1, processID</p><p>While Application.IsAppRunning(processID)</p><p>' Espera pelo final da aplicação</p><p>Wend</p><p>MsgBox "Terminou a aplicação!"</p><p>End Sub</p><p>NOTA</p><p>O parâmetro ProcessId é o mesmo valor que aparece no Gerenciador de Tarefas do Windows, na coluna PID.</p><p>4.1.2.19 IsUserMemberOfGroup</p><p>IsUserMemberOfGroup(GroupName, [UserName])</p><p>Este método verifica se um usuário pertence a um determinado grupo. Possui os seguintes parâmetros:</p><p>· GroupName: Nome do grupo de usuários que se quer verificar</p><p>67</p><p>Visualização</p><p>· UserName: Nome do usuário que se quer verificar. Se este parâmetro é omitido ou é igual a uma String vazia, o</p><p>método considera o usuário atualmente logado no Elipse E3 Viewer</p><p>Este método retorna Verdadeiro se o usuário pertencer ao grupo indicado por GroupName ou Falso caso contrário.</p><p>4.1.2.20 IsWebViewer</p><p>IsWebViewer()</p><p>Verifica se a aplicação está sendo visualizada pelo WebViewer. O método retorna Verdadeiro se a aplicação estiver</p><p>sendo executada no WebViewer. Caso contrário, retorna Falso.</p><p>4.1.2.21 LoadFormulaDlg</p><p>LoadFormulaDlg(FormulaName, [UnitName], [ValueName])</p><p>Este método abre uma caixa de diálogo que exibe as Unidades e os Conjuntos de Valores configurados em uma</p><p>Fórmula (FormulaName), permitindo ao usuário selecionar o Conjunto de Valores e a Unidade em que este Conjunto é</p><p>carregado.</p><p>Os parâmetros opcionais UnitName e ValueName são variáveis que recebem, respectivamente, o nome da Unidade e</p><p>o nome do Conjunto de Valores carregados na Fórmula. A caixa de diálogo da figura a seguir é mostrada como</p><p>resultado da chamada a este método no código de exemplo que segue. Este método retorna um valor Booleano</p><p>indicando se foi executado com sucesso ou não.</p><p>Caixa de diálogo do método LoadFormulaDlg</p><p>O código a seguir contém um exemplo de uso deste método.</p><p>Sub Botao1_Click()</p><p>NomeFormula = "Formula1"</p><p>If Application.LoadFormulaDlg(NomeFormula, NomeUnidade, ConjuntoValores) Then</p><p>MsgBox "O Conjunto de Valores " & ConjuntoValores & " foi carregado na Unidade " &</p><p>NomeUnidade</p><p>Else</p><p>MsgBox "Falha ao carregar a Fórmula " & NomeFormula</p><p>End If</p><p>End Sub</p><p>4.1.2.22 LoadFormulaValues</p><p>LoadFormulaValues(FormulaName, UnitName, ValueName)</p><p>Este método carrega automaticamente um Conjunto de Valores para uma Unidade de destino, apresentando uma</p><p>caixa de diálogo que permite ao usuário informar valores diferentes daqueles definidos na Fórmula. Este método</p><p>possui os parâmetros FormulaName, que determina o nome da Fórmula, UnitName, que determina o nome da</p><p>Unidade e ValueName,</p><p>consultas e penas. Note que cada objeto contribui para a funcionalidade do todo: as escalas ajudam</p><p>a localizar os valores dos pontos no E3Chart, as legendas ajudam a identificar a pena e seus valores e a pena realiza</p><p>o desenho dos valores no E3Chart.</p><p>Através da manipulação de objetos dentro do E3Chart, pode-se criar duas instâncias deste objeto bastante diferentes</p><p>entre si. Para se manipular um objeto específico, deve-se acessá-lo através de uma hierarquia. Se os dois objetos</p><p>E3Chart estiverem na mesma Tela, deve-se acessar primeiro a Tela, depois o E3Chart desejado, depois uma de suas</p><p>propriedades ou objetos filhos. Quando há vários objetos de um mesmo tipo, geralmente eles podem ser acessados</p><p>através de uma coleção (collection). Uma coleção é um objeto especial que gerencia um conjunto de objetos</p><p>semelhantes. Um exemplo no objeto E3Chart é a coleção Pens, que permite o acesso a todas as penas do E3Chart.</p><p>1.2 Scripts</p><p>A linguagem que o Elipse E3 Studio usa em seus scripts é o VBScript, um subconjunto da linguagem Visual Basic</p><p>desenvolvida pela Microsoft. O VBScript possui um interpretador rápido, leve e portável, desenvolvido para uso em</p><p>navegadores para a Internet e outras aplicações que usam ActiveX Controls, Automation Servers e Java Applets.</p><p>Conforme visto anteriormente, os scripts são associados a eventos de um objeto. Entretanto, para facilitar e aumentar</p><p>a velocidade de desenvolvimento, o Elipse E3 já incorpora algumas ações mais comuns que poderiam ser realizadas</p><p>com scripts, através de assistentes chamados Picks. Pode-se portanto definir que um determinado evento executa um</p><p>script, um Pick ou uma combinação deles, em uma sequência também pré-definida.</p><p>Cada Editor do Elipse E3 Studio apresenta pelo menos duas abas na parte inferior, Design e Scripts, com exceção</p><p>dos objetos Banco de Dados e Servidor de Alarmes, que não possuem a aba Design. Os objetos e seus filhos podem</p><p>ser manipulados na aba Design. Para manipular seus scripts, utilize a aba Scripts. As opções disponíveis na aba</p><p>Scripts estão descritas na tabela a seguir.</p><p>Opções disponíveis na aba Scripts</p><p>OPÇÃO DESCRIÇÃO</p><p>Lista de Objetos</p><p>Seleciona o objeto cujo script é manipulado</p><p>Lista de Eventos</p><p>Seleciona o evento a ser aplicado ao objeto</p><p>Script Adiciona um script associado ao evento</p><p>Pick Abrir Tela Adiciona um Pick Abrir Tela</p><p>Introdução</p><p>2</p><p>OPÇÃO DESCRIÇÃO</p><p>Pick Abrir Tela Modal Adiciona um Pick Abrir Tela Modal</p><p>Pick Executar Aplicação Adiciona um Pick Executar Aplicação</p><p>Pick Carregar Valor Adiciona um Pick Carregar Valor</p><p>Pick Inverter Valor Adiciona um Pick Inverter Valor</p><p>Pick Imprimir Relatório Adiciona um Pick Imprimir Relatório</p><p>Remover script ou Pick selecionado Remove o script ou o Pick selecionado na</p><p>Lista de Ações</p><p>Mover script ou Pick selecionado para cima Move a ação selecionada para cima na</p><p>ordem da Lista de Ações para o evento</p><p>Mover script ou Pick selecionado para baixo Move a ação selecionada para baixo na</p><p>ordem da Lista de Ações para o evento</p><p>AppBrowser Abre a janela do AppBrowser</p><p>Procurar Busca por ocorrências de um determinado</p><p>texto</p><p>Procurar anterior Seleciona na lista de resultados a ocorrência</p><p>anterior</p><p>Procurar próxima Seleciona na lista de resultados a ocorrência</p><p>seguinte</p><p>Substituir Substitui as ocorrências encontradas por</p><p>outro texto especificado</p><p>Compila o script selecionado Compila o script selecionado, mostrando os</p><p>erros no painel Mensagens</p><p>Compila todos os scripts deste evento Compila todos os scripts associados ao</p><p>evento</p><p>Compila todos os eventos deste objeto Compila todos os eventos associados ao</p><p>objeto</p><p>A ordem de execução das ações é de cima para baixo. Para alterar a ordem, pode-se utilizar as opções Mover script</p><p>ou Pick selecionado para cima e Mover script ou Pick selecionado para baixo . Utilize a opção Compila o</p><p>script selecionado para verificar se não há erros no script especificado para o evento. As mensagens de erro do</p><p>compilador são apresentadas no painel Mensagens, que pode estar em uma janela flutuante ou ancorado na parte</p><p>inferior ou superior da aba Scripts. Clique duas vezes no erro para selecioná-lo no script.</p><p>3</p><p>Introdução</p><p>Mensagem do compilador</p><p>1.2.1 Adicionando um Script</p><p>Para adicionar um script a um objeto, siga estes procedimentos:</p><p>1. Selecione o objeto para criar o script e clique na aba Scripts.</p><p>Aba Scripts</p><p>2. Clique em Script para abrir o Editor de Scripts, conforme a figura a seguir.</p><p>Introdução</p><p>4</p><p>Adicionando um script ao objeto</p><p>3. Digite os comandos em VBScript na caixa de edição de texto.</p><p>NOTA</p><p>Utilize o caractere de sublinhado para acrescentar uma quebra de linha e deixar o código mais legível. O caractere</p><p>de sublinhado indica que o código continua na linha subsequente.</p><p>O código a seguir contém um exemplo de script.</p><p>If intTemperaturaCaldeira3 > 120 and _</p><p>intTemperaturaCaldeira4 > 120 Then</p><p>bEnviarAlarme = True</p><p>bAlarmeLigado = True</p><p>End If</p><p>Cada evento pode ter vários scripts e vários Picks associados, chamados Ações do Evento. A lista das ações pode ser</p><p>vista na parte superior da janela de edição de scripts. Cada objeto pode ter qualquer quantidade de eventos com</p><p>scripts ou Picks associados.</p><p>NOTA</p><p>Ao clicar com o botão direito do mouse em qualquer uma das ações descritas anteriormente, abre-se um menu</p><p>contextual que possibilita recortar, copiar ou colar scripts e Picks entre eventos.</p><p>1.3 Picks</p><p>Os Picks implementam uma forma mais amigável de realizar procedimentos mais comuns, poupando tempo de</p><p>configuração. Entre estes procedimentos estão ações como trocas de Tela ou atribuição de valores, bastante comuns</p><p>na criação de um projeto. Os tópicos a seguir descrevem os Picks disponíveis na aba Scripts.</p><p>NOTA</p><p>Todas as opções dos Picks que estão disponíveis via menu contextual (através do clique com o botão direito do</p><p>mouse) também estão disponíveis utilizando o atalho de teclado SHIFT + F10, que corresponde à tecla de aplicação</p><p>ou de menu .</p><p>5</p><p>Introdução</p><p>1.3.1 Abrir Tela</p><p>Abre uma determinada Tela ou Quadro.</p><p>Configurações do Pick Abrir Tela</p><p>Opções disponíveis no Pick Abrir Tela</p><p>OPÇÃO DESCRIÇÃO</p><p>Abrir a tela Indica qual Tela deve ser aberta</p><p>No quadro Indica o Quadro onde a Tela é visualizada. Se estiver em</p><p>branco, é o Quadro principal (_top)</p><p>Zoom inicial Define o zoom da Tela, quando mostrada</p><p>Alinhamento da Tela Define o alinhamento da Tela em relação à área visível.</p><p>Os valores possíveis são Utilizar padrão, Forçar</p><p>Esquerdo Superior ou Forçar Centralizado</p><p>Parâmetro Indica um parâmetro a ser passado na chamada da Tela</p><p>Habilitar rolagem da Tela Habilita o uso das barras de rolagem na Tela</p><p>Especificar a posição da janela Indica a posição da janela, em pixels</p><p>Especificar o tamanho da janela Indica o tamanho da janela, em pixels ou em Himetric</p><p>Estilo da janela Abre a caixa de diálogo Estilo de janela</p><p>1.3.1.1 Caixa de Diálogo Estilo de Janela</p><p>Permite configurar o estilo da janela a ser mostrada, definindo título e a disponibilidade das bordas e botões de</p><p>fechar, maximizar e minimizar, entre outras opções. Se a opção Usar configuração padrão das janelas está</p><p>Introdução</p><p>6</p><p>selecionada, a aplicação desabilita as opções desta janela e assume a configuração padrão do Viewer, conforme as</p><p>opções configuradas na aba Visualizador das propriedades</p><p>que determina o nome do Conjunto de Valores.</p><p>Uma caixa de mensagem aparece permitindo ao usuário informar valores diferentes daqueles definidos para cada um</p><p>dos valores da Fórmula.</p><p>Visualização</p><p>68</p><p>NOTA</p><p>Este método retorna um valor lógico, ou seja, retorna Verdadeiro quando é executada com sucesso e Falso quando</p><p>falha, o que não significa que houve um erro no script.</p><p>O código a seguir contém um exemplo de uso deste método.</p><p>Sub Botao1_Click()</p><p>Application.LoadFormulaValues "Formula1",</p><p>"Unidade1", "Valor1"</p><p>End Sub</p><p>4.1.2.23 LoadFormulaValuesQuiet</p><p>LoadFormulaValuesQuiet(FormulaName, UnitName, ValueName)</p><p>Carrega um Conjunto de Valores para uma Unidade de destino, sem apresentar nenhuma mensagem. Este método</p><p>possui os parâmetros FormulaName, que determina o nome da Fórmula, UnitName, que determina o nome da</p><p>Unidade e ValueName, que determina o nome do Conjunto de Valores. O código a seguir contém um exemplo de uso</p><p>deste método.</p><p>Sub Botao1_Click()</p><p>Application.LoadFormulaValuesQuiet "Formula1",_</p><p>"Unidade3", "Valor1"</p><p>End Sub</p><p>NOTA</p><p>Este método também está acessível através do objeto Fórmula.</p><p>4.1.2.24 LoadReport</p><p>LoadReport(ReportName)</p><p>Carrega um modelo de Relatório de Seção. O parâmetro ReportName é o nome do Relatório de Seção a ser</p><p>carregado. O código a seguir contém um exemplo de uso deste método.</p><p>Sub Rect_Click()</p><p>' Carregando o Relatório de Seção pré-definido</p><p>Set strRep = Application.LoadReport("[Relatório3]")</p><p>strRep.PrintPreview ' Visualizando a impressão</p><p>End Sub</p><p>4.1.2.25 Login</p><p>Login([Mode], [PosX], [PosY], [WindowsShowLastCredentials])</p><p>Abre uma caixa de diálogo para o login, ou autenticação de usuário, na aplicação. O usuário logado permanece na</p><p>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,</p><p>todos opcionais, são os seguintes:</p><p>· Mode: Um Booleano que determina se uma mensagem de confirmação ou falha da operação deve ser mostrada.</p><p>Se este parâmetro é omitido, a mensagem de confirmação ou falha de operação não é mostrada. Quando uma</p><p>Tela estiver para ser aberta, através do método OpenScreen, este método verifica se existe alguma configuração</p><p>de segurança. Caso exista, a Tela só é aberta se o usuário logado tem permissão. Caso não tenha permissão,</p><p>abre-se uma caixa de diálogo para o login</p><p>· PosX: Indica a posição, em pixels, da caixa de diálogo em relação à margem esquerda da janela. Caso este</p><p>parâmetro seja omitido, a respectiva coordenada da caixa de diálogo é centralizada na janela</p><p>· PosY: Indica a posição, em pixels, da caixa de diálogo em relação à margem superior da janela. Caso este</p><p>parâmetro seja omitido, a respectiva coordenada da caixa de diálogo é centralizada na janela</p><p>· WindowShowLastCredentials: Um Booleano que indica se, ao selecionar a autenticação pelo Windows, os</p><p>campos de usuário e senha são completados com o usuário atualmente logado no Windows. Se este parâmetro é</p><p>omitido, os campos de usuário e senha são completados</p><p>NOTA</p><p>Caso ambos os parâmetros PosX e PosY sejam omitidos, a caixa de diálogo é centralizada na janela.</p><p>69</p><p>Visualização</p><p>4.1.2.26 LoginUser</p><p>LoginUser(Username, UserPassword, [OpStatus], [WarnDaysToExpire])</p><p>Executa uma operação de login de um usuário específico sem mostrar nenhuma mensagem. O parâmetro Username é</p><p>o nome do usuário e o parâmetro UserPassword é a senha deste usuário. O parâmetro opcional de retorno OpStatus é</p><p>um mapa de bits que indica o status desta operação e o parâmetro opcional de retorno WarnDaysToExpire indica o</p><p>número de dias para que a senha em UserPassword expire. Este método retorna um Booleano indicando se a</p><p>operação falhou ou não. Consulte as tabelas a seguir para mais informações sobre os valores possíveis em caso de</p><p>falha.</p><p>NOTA</p><p>Este método só está disponível se o usuário logado é um usuário do Domínio do Elipse E3.</p><p>Valores de retorno possíveis para o parâmetro OpStatus</p><p>VALOR DESCRIÇÃO</p><p>0x000000 Nenhum erro</p><p>0x000001 Erro não especificado</p><p>0x000002 Usuário ou senha incorretos</p><p>0x000004 A senha atual deve ser alterada</p><p>0x000008 A senha atual expirou</p><p>0x000010 A conta deste usuário está bloqueada</p><p>0x000020 A conta deste usuário está desabilitada</p><p>0x000040 O servidor RPC não está disponível</p><p>0x000080 Modo de autenticação não suportado</p><p>0x001000 Senha não informada</p><p>0x002000 Este usuário não tem permissão para alterar a senha</p><p>0x004000 A senha informada não é alfanumérica</p><p>0x008000 A senha informada não possui letras maiúsculas e</p><p>minúsculas</p><p>0x010000 A senha informada é muito curta</p><p>0x020000 A senha informada não possui a quantidade mínima de</p><p>números</p><p>0x040000 A senha informada não possui a quantidade mínima de</p><p>letras</p><p>0x080000 A senha informada não possui a quantidade mínima de</p><p>caracteres especiais</p><p>0x100000 A senha informada é igual ao nome do usuário</p><p>0x200000 A senha informada foi utilizada recentemente</p><p>0x400000 A senha atual não atingiu a idade mínima</p><p>Valores de retorno possíveis para o parâmetro WarnDaysToExpire</p><p>VALOR DESCRIÇÃO</p><p>-1 (menos um) A senha está fora do intervalo de expiração ou nunca</p><p>expira</p><p>0 (zero) A senha expira hoje</p><p>Visualização</p><p>70</p><p>VALOR DESCRIÇÃO</p><p>n A senha expira daqui a n dias dentro do intervalo de</p><p>expiração configurado</p><p>4.1.2.27 LoginWindowsUser</p><p>LoginWindowsUser([UserName], [UserPassword], [OpStatus])</p><p>Este método executa uma operação de login utilizando um usuário do Windows sem mostrar nenhuma mensagem. O</p><p>parâmetro opcional UserName é o nome do usuário e o parâmetro opcional UserPassword é a senha deste usuário. O</p><p>parâmetro de retorno opcional OpStatus é um mapa de bits que indica o status desta operação. Este método retorna</p><p>um Booleano indicando se a operação falhou ou não. Consulte a tabela Valores de retorno possíveis para o</p><p>parâmetro OpStatus no método LoginUser para mais informações sobre os valores possíveis em caso de falha. Caso</p><p>o nome do usuário seja omitido, a operação de login é executada com o usuário corrente do Windows.</p><p>4.1.2.28 Logout</p><p>Logout([Mode])</p><p>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</p><p>método não tem efeito. A partir deste momento, considera-se que um usuário anônimo está utilizando a aplicação.</p><p>Pode-se utilizar o evento OnLogout para executar um script para ir para a Tela inicial ou finalizar a aplicação. Este</p><p>método possui o parâmetro opcional Mode, que é um Booleano que determina se uma mensagem de confirmação ou</p><p>falha da operação deve ser mostrada. Se este parâmetro é omitido, a mensagem de confirmação ou falha de</p><p>operação não é mostrada.</p><p>4.1.2.29 PasswordConfirm</p><p>PasswordConfirm([Mode], [PosX], [PosY])</p><p>Este método abre uma caixa de diálogo solicitando a reconfirmação da senha do usuário atualmente logado. Retorna</p><p>Verdadeiro se a senha é confirmada ou Falso caso contrário. O parâmetro opcional Mode determina se deve ser</p><p>executado um logout em caso de falha na confirmação (Verdadeiro) ou não (Falso). Se omitido, não é executado um</p><p>logout em caso de falha de confirmação. O parâmetro opcional PosX indica a posição, em pixels, da caixa de diálogo</p><p>em relação à margem esquerda da janela. Caso este parâmetro seja omitido, a respectiva coordenada da caixa de</p><p>diálogo é centralizada na janela. O parâmetro opcional PosY indica a posição, em pixels, da caixa de diálogo em</p><p>relação à margem superior da janela. Caso este parâmetro seja omitido, a respectiva coordenada da caixa de diálogo</p><p>é centralizada na janela. Caso os valores indicados nos parâmetros PosX e PosY posicionem a caixa de diálogo fora da</p><p>área visível da janela,</p><p>estes valores são ajustados automaticamente para garantir que a caixa de diálogo esteja visível.</p><p>Confirmação de senha</p><p>Se a caixa de diálogo é fechada clicando em Cancelar, este método retorna Falso. Caso não haja usuário logado, este</p><p>método retorna Falso, mas sem abrir a caixa de diálogo. Caso a senha digitada não esteja correta, a solicitação é</p><p>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 é</p><p>fechada e este método retorna Falso.</p><p>NOTA</p><p>Este método só está disponível se o usuário logado é um usuário do Domínio do Elipse E3.</p><p>71</p><p>Visualização</p><p>4.1.2.30 Playsound</p><p>Playsound(FileName)</p><p>Executa um arquivo de som cujo caminho e nome estão indicados no parâmetro FileName. O arquivo deve ter as</p><p>seguintes especificações:</p><p>· Deve estar no formato de som do Windows, com a extensão .wav</p><p>· Se o arquivo está no projeto, adicionado através do comando Inserir recurso, o nome do arquivo deve estar</p><p>entre colchetes</p><p>· Se foi criada uma pasta no projeto e o arquivo foi adicionado através do comando Inserir recurso, o caminho</p><p>deve ser especificado entre aspas, como por exemplo "c:\som\ding.wav". Se o arquivo está no diretório local, o</p><p>nome não precisa de aspas, apenas o caminho, como por exemplo c:\som\ding.wav</p><p>O código a seguir contém um exemplo de uso deste método.</p><p>Sub TelaInicial_OnAlarm()</p><p>' Se existir um alarme ativo, executa um som de alerta.</p><p>' Quando o alarme é reconhecido, o som para.</p><p>Set Alarme = Application._</p><p>GetObject("ConfigAlarmes1.Area1.FonteAlarme1")</p><p>If Alarme.ActiveNACKAlarms = True Then</p><p>Application.PlaySound("[ringin.wav]")</p><p>End If</p><p>End Sub</p><p>4.1.2.31 SelectMenu</p><p>SelectMenu(Menu, [Left], [Top])</p><p>Este método mostra um menu contextual conforme especificado pelo parâmetro Menu. Este parâmetro é um texto que</p><p>consiste em várias opções delimitadas por uma barra vertical (|), e cada uma destas Strings é uma opção do menu.</p><p>Caso haja um conjunto de dois delimitadores sucessivos (||), um separador é inserido. Use os caracteres de abre e</p><p>fecha chaves para criar um submenu. Um asterisco na frente de uma String indica que a opção está marcada. Já um</p><p>sinal de exclamação indica que a opção está desabilitada.</p><p>A posição da caixa de diálogo pode ser configurada através dos parâmetros opcionais Left e Top, que indicam a</p><p>distância da margem esquerda e do topo da Tela em pixels, respectivamente. Caso estes parâmetros não sejam</p><p>informados, o menu é posicionado de acordo com o local onde o clique do mouse foi acionado.</p><p>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</p><p>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</p><p>uso deste método.</p><p>Sub Botao1_Click()</p><p>op = _</p><p>Application.SelectMenu(_</p><p>"Opção1||Opção2{*Opção2|Opção3}|Opção4|!Opção5")</p><p>If op = 1 Then</p><p>MsgBox "Opção 1 foi escolhida"</p><p>ElseIf op = 2 Then</p><p>MsgBox "Opção 2 foi escolhida"</p><p>ElseIf op = 3 Then</p><p>MsgBox "Opção 3 foi escolhida"</p><p>ElseIf op = 4 Then</p><p>MsgBox "Opção 4 foi escolhida"</p><p>ElseIf op = 0 Then</p><p>MsgBox "Nenhuma opção foi escolhida"</p><p>End If</p><p>End Sub</p><p>4.1.2.32 SetValue</p><p>SetValue(TagName, NewVal)</p><p>Este método configura o valor de um objeto dentro do servidor. Este método procura por um objeto ou propriedade</p><p>em execução no servidor e atribui o valor especificado no parâmetro definido em TagName. O tipo e o valor do</p><p>parâmetro NewVal devem ser suportados pelo objeto especificado em TagName. O código a seguir contém um</p><p>exemplo de uso deste método.</p><p>Sub Botao1_Click()</p><p>' Ao clicar em Botao1, atribui o valor 20</p><p>' para a propriedade Value do Tag</p><p>Visualização</p><p>72</p><p>Application.SetValue "Dados1.TagInterno1", 20</p><p>End Sub</p><p>4.1.2.33 ShowDatePicker</p><p>ShowDatePicker(DateValue, [Left], [Top], [DefaultDate])</p><p>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</p><p>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</p><p>de diálogo pode ser configurada através dos parâmetros opcionais Left e Top, que indicam a distância da margem</p><p>esquerda e do topo da tela em pixels, respectivamente. Caso estes parâmetros não sejam informados, a caixa de</p><p>diálogo é centralizada. O valor do parâmetro opcional DefaultDate é a data e a hora do momento em que a caixa de</p><p>diálogo é aberta. Se não é informada a data, assume a data atual. Se não é informada a hora, inicia como "00:00:00".</p><p>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</p><p>de uso deste método.</p><p>Sub Texto2_Click()</p><p>Dim novaHora</p><p>Application.ShowDatePicker novaHora, 300, 300</p><p>MsgBox "A hora é: " & novaHora</p><p>End Sub</p><p>4.1.2.34 ShowFilePicker</p><p>ShowFilePicker(Open, Filename, [Extension], [Flags], [Filter])</p><p>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</p><p>ser aberta. Se Verdadeiro, abre a caixa de diálogo Abrir Arquivo. Se Falso, abre a caixa de diálogo Salvar. O</p><p>parâmetro FileName indica a variável onde é armazenado o nome do arquivo a ser salvo ou carregado, caso o</p><p>método retorne Verdadeiro. Este parâmetro deve ser obrigatoriamente uma variável. O parâmetro Extension é</p><p>opcional e informa a extensão do arquivo padrão a ser anexada ao nome do arquivo na caixa de entrada, quando a</p><p>extensão não é informada. Caso seja omitido ou seja uma String vazia, nenhuma extensão é concatenada ao final do</p><p>nome do arquivo. Extensões múltiplas podem ser especificadas usando-se o caractere de ponto e vírgula como</p><p>delimitador. A String deve terminar com barras duplas verticais (||).</p><p>O parâmetro Flags é opcional e define o comportamento da caixa de diálogo. É um número inteiro correspondendo à</p><p>soma dos valores da tabela a seguir. Se omitido, assume o valor 2 (dois, FILEMUSTEXIST). O parâmetro Filter é</p><p>opcional e define um conjunto de pares de Strings que especificam filtros que podem ser aplicados aos arquivos. A</p><p>primeira String descreve o filtro e a segunda String indica o tipo de extensão a ser utilizada. Se omitido, nenhum filtro</p><p>é aplicado aos arquivos.</p><p>Combinações possíveis para o parâmetro Flags</p><p>VALOR DESCRIÇÃO</p><p>1 CREATEPROMPT: Se o usuário especificar um arquivo</p><p>que não existe, este flag permite que seja questionado</p><p>sobre a criação do arquivo. Ao selecionar criar o arquivo,</p><p>a caixa de diálogo é fechada e o nome do arquivo é</p><p>retornado no parâmetro Filename. Caso contrário, a caixa</p><p>de diálogo permanece aberta</p><p>2 FILEMUSTEXIST: Especifica que o usuário só pode</p><p>digitar nomes de arquivos existentes. Caso contrário, a</p><p>caixa de diálogo mostra um aviso na caixa de mensagens</p><p>4 NOCHANGEDIR: Recupera o diretório atual para o valor</p><p>original, caso o usuário tenha mudado de diretório</p><p>enquanto buscava o arquivo</p><p>8 NODEREFERENCELINKS: Configura a caixa de diálogo</p><p>para retornar o arquivo de atalho (.lnk) selecionado. Se</p><p>este flag não é especificado, a caixa de diálogo retorna o</p><p>caminho e nome de arquivo referenciados pelo arquivo</p><p>de atalho</p><p>16 NOREADONLYRETURN: Determina que o arquivo</p><p>retornado não seja somente para leitura, e o diretório</p><p>não é protegido contra gravação</p><p>73</p><p>Visualização</p><p>VALOR DESCRIÇÃO</p><p>32 PATHMUSTEXIST: Especifica que o usuário pode</p><p>informar apenas arquivos e diretórios válidos, caso</p><p>contrário uma caixa de mensagem é mostrada para</p><p>avisar o usuário</p><p>64 READONLY: Permite que a opção Somente Leitura seja</p><p>selecionada inicialmente quando a caixa de diálogo é</p><p>criada</p><p>128 OVERWRITEPROMPT:</p><p>Permite que a caixa de diálogo</p><p>Salvar Como gere uma mensagem informando da</p><p>existência do arquivo, e pede confirmação para</p><p>sobrescrever este arquivo</p><p>O código a seguir contém um exemplo de filtro para este método.</p><p>"Arquivos de Chart (*.xlc)|*.xlc|Planilhas Excel (*.xls)_</p><p>|*.xls|Arquivos de Dados (*.xlc;*.xls)|*.xlc; *.xls</p><p>|Todos os arquivos (*.*)|*.*||"</p><p>4.1.2.35 ShowPickColor</p><p>ShowPickColor(ColorValue, [Color], [Left], [Top])</p><p>Abre a caixa de diálogo Cores do Windows para selecionar uma cor. O valor decimal da cor selecionada é retornado</p><p>no parâmetro ColorValue. O parâmetro opcional Color indica uma cor previamente selecionada na paleta de cores. Se</p><p>este parâmetro não é informado, assume o valor 0 (zero, preto). A posição da caixa de diálogo pode ser configurada</p><p>através dos parâmetros opcionais Left e Top, que indicam respectivamente a distância da margem esquerda e do topo</p><p>da tela, em pixels. Caso estes parâmetros não sejam informados, a caixa de diálogo é centralizada. O código a seguir</p><p>contém um exemplo de uso deste método.</p><p>Sub CommandButton_Click()</p><p>Dim novaCor</p><p>Dim corPadrao</p><p>corPadrao = 65280 ' Verde Claro</p><p>If Application.ShowPickColor(novaCor, corPadrao, 90, 90) Then</p><p>Screen.Item("Retangulo1").ForegroundColor = novaCor</p><p>Screen.Item("Texto1").Value = novaCor</p><p>End If</p><p>End Sub</p><p>4.1.2.36 ShowTrendAnalysis</p><p>ShowTrendAnalysis([Title], [Left], [Top], [Configuration], [ConfigStatus], [ErrorDetails])</p><p>Mostra uma janela do TrendAnalysis. Este método retorna Verdadeiro se a janela foi mostrada corretamente ou Falso</p><p>em caso de erro. Os parâmetros deste método estão listados na tabela a seguir.</p><p>Parâmetros do método ShowTrendAnalysis</p><p>PARÂMETRO DESCRIÇÃO</p><p>Title Determina o título da janela. Corresponde à propriedade</p><p>Title do objeto TrendAnalysis. Se omitido ou informada</p><p>uma String vazia, o título da janela é configurado para</p><p>"TrendAnalysis"</p><p>Left Coordenada horizontal da janela, em pixels. Consulte o</p><p>método SetWindowPlacement do objeto TrendAnalysis</p><p>para mais informações sobre o comportamento deste</p><p>parâmetro, caso seja omitido</p><p>Top Coordenada vertical da janela, em pixels. Consulte o</p><p>método SetWindowPlacement do objeto TrendAnalysis</p><p>para mais informações sobre o comportamento deste</p><p>parâmetro, caso seja omitido</p><p>Visualização</p><p>74</p><p>PARÂMETRO DESCRIÇÃO</p><p>Configuration Informa o conteúdo de uma configuração salva pelo</p><p>método Save do objeto TrendAnalysis. Se omitido ou</p><p>informada uma String vazia, não carrega nenhuma</p><p>configuração previamente salva</p><p>ConfigStatus Parâmetro opcional de retorno que informa o resultado</p><p>do carregamento da janela do TrendAnalysis. Se este</p><p>método retorna Verdadeiro, este parâmetro contém o</p><p>valor 0 (zero), ou seja, a configuração foi carregada com</p><p>sucesso. Se este método retorna Falso, este parâmetro</p><p>pode conter os valores 1: A configuração não carregou</p><p>corretamente, 2: O conteúdo da configuração é inválido</p><p>ou 3: Esta configuração requer uma versão mais recente</p><p>ErrorDetails Parâmetro opcional de retorno contendo uma String</p><p>detalhando o erro no carregamento da janela do</p><p>TrendAnalysis</p><p>O código a seguir contém um exemplo de uso deste método.</p><p>Sub Botao1_Click()</p><p>Dim showResult, errorMsg, errorDetails</p><p>showResult = Application.ShowTrendAnalysis("TrendAnalysis", 100, 100, "", ConfigStatus,</p><p>errorDetails)</p><p>If showResult = False Then</p><p>If ConfigStatus <> 0 Then</p><p>Select Case ConfigStatus</p><p>Case 1</p><p>errorMsg = "Erro (1): A configuração não foi carregada corretamente."</p><p>Case 2</p><p>errorMsg = "Erro (2): O conteúdo da configuração é inválido."</p><p>Case 3</p><p>errorMsg = "Erro (3): Esta configuração requer uma versão mais recente."</p><p>End Select</p><p>errorMsg = errorMsg & vbCrLf & "Detalhes: " & errorDetails</p><p>MsgBox errorMsg</p><p>End If</p><p>End If</p><p>End Sub</p><p>NOTA</p><p>As propriedades do objeto TrendAnalysis podem ser configuradas no objeto retornado pelo método</p><p>GetTrendAnalysis.</p><p>4.1.2.37 Stopsound</p><p>Stopsound()</p><p>Para um som que esteja executando.</p><p>4.1.2.38 ToggleValue</p><p>ToggleValue(TagName, ValA, ValB)</p><p>Este método busca o valor do objeto ou propriedade em execução no servidor e compara com os parâmetros ValA e</p><p>ValB. Se o valor buscado é igual a ValB, o objeto ou propriedade especificado em TagName recebe o valor de ValA.</p><p>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</p><p>valor especificado em ValA. O código a seguir contém um exemplo de uso deste método.</p><p>Sub Botao1_Click()</p><p>' Ao clicar no Botão, atribui o valor</p><p>' a um Tag sendo executado em um Servidor de Dados.</p><p>' Atribui o valor 20 para o Tag.</p><p>Application.SetValue "Dados1.TagInterno1", 20</p><p>' Já que o valor do TagInterno1 já é 20,</p><p>' o método ToggleValue alterna o valor para 30.</p><p>Application.ToggleValue "Dados1.TagInterno1", 30, 20</p><p>End Sub</p><p>75</p><p>Visualização</p><p>4.1.2.39 Trace</p><p>Trace(MessageText, [LogTimeStamp], [BreakLine])</p><p>Este método permite registrar mensagens no log do Elipse E3. Este método pode ser usado, por exemplo, para</p><p>registrar mensagens de depuração de scripts executados no Viewer.</p><p>Parâmetros do método Trace</p><p>PARÂMETRO DESCRIÇÃO</p><p>MessageText Mensagem definida pelo usuário</p><p>LogTimeStamp Booleano que indica se cada registro deve ter a data e a</p><p>hora (timestamp). Este parâmetro é opcional e é</p><p>ignorado no Elipse E3 Viewer</p><p>BreakLine Booleano que indica a presença ou não de uma quebra</p><p>de linha ao final de cada mensagem. Este parâmetro é</p><p>opcional e é ignorado no Elipse E3 Viewer</p><p>4.1.2.40 TrackEvent</p><p>TrackEvent(EventMessage, [Comment], [EventTimeStamp])</p><p>Este método permite gerar eventos via script manualmente. Estes eventos podem ser gerados tanto no Elipse E3</p><p>Viewer quanto no Servidor, e são registrados em uma tabela no banco de dados da aplicação.</p><p>Parâmetros do método TrackEvent</p><p>NOME DESCRIÇÃO</p><p>EventMessage Contém a mensagem do evento, com um máximo de 200</p><p>caracteres</p><p>Comment Contém comentários adicionais sobre um evento, com</p><p>um máximo de 200 caracteres. Este parâmetro é opcional</p><p>e, se omitido, assume uma String vazia</p><p>TimeStamp Indica a data e hora em que um evento ocorreu. Este</p><p>parâmetro é opcional e, se omitido, o Elipse E3 assume</p><p>a data e a hora atuais</p><p>Este método só registra os eventos caso a opção de Registro de Eventos nas Opções do Domínio esteja habilitada.</p><p>Os eventos são registrados em uma tabela de um banco de dados, que é definida também nas configurações de</p><p>Registro de Eventos.</p><p>Para mais informações sobre o Registro de Eventos do Domínio, consulte o Manual do Usuário do Elipse E3. O</p><p>código a seguir contém um exemplo de uso deste método.</p><p>Sub Button1_Click()</p><p>Dim Tag, User, Comment</p><p>Set Tag = Application.GetObject("IO.Inputs.I001")</p><p>If Application.ESign(Tag.PathName, , "Alteração do Valor", _</p><p>Tag.Value, 1, User, Comment) Then</p><p>If Tag.WriteEx(1) Then</p><p>Application.TrackEvent _</p><p>"Tag IO.Inputs.I001 alterado para 1 " &_</p><p>"pelo usuário" & User, Comment</p><p>End If</p><p>End If</p><p>End Sub</p><p>4.1.2.41 UserAdministration</p><p>UserAdministration([PosX], [PosY], [ShowMergeErrorsOnExit], [MergeDetails])</p><p>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</p><p>as seguintes:</p><p>· Mostrar a lista de todos os usuários</p><p>· Excluir usuários (não é possível excluir o usuário atual)</p><p>· Adicionar e editar usuários</p><p>Visualização</p><p>76</p><p>· Editar as configurações de um usuário</p><p>· Alterar a senha de um usuário</p><p>· Alterar os demais dados de um usuário, tais como nome de login e nome completo</p><p>Este método possui os seguintes parâmetros:</p><p>· PosX: Parâmetro</p><p>opcional que indica a posição, em pixels, da caixa de diálogo em relação à margem esquerda</p><p>da janela</p><p>· PosY: Parâmetro opcional que indica a posição, em pixels, da caixa de diálogo em relação à margem superior da</p><p>janela</p><p>· ShowMergeErrorsOnExit: Parâmetro Booleano opcional que indica se deve ser mostrada uma janela com os</p><p>erros durante a execução deste método. Caso este parâmetro seja omitido, nenhuma janela é mostrada ao final</p><p>da execução</p><p>· MergeDetails: Parâmetro opcional de saída contendo uma String com os erros acontecidos durante a execução</p><p>deste método</p><p>Caso os parâmetros PosX e PosY sejam omitidos, a respectiva coordenada da caixa de diálogo é centralizada na</p><p>janela, e caso algum dos valores destes parâmetros posicionem a caixa de diálogo fora da área visível da janela, os</p><p>valores são automaticamente ajustados para garantir que a caixa de diálogo esteja visível.</p><p>Este método retorna Verdadeiro se não houve nenhum problema na edição e Falso caso contrário. O código a seguir</p><p>contém um exemplo de uso deste método.</p><p>Sub CommandButton_Click()</p><p>'Variáveis para receber o resultado</p><p>'e os erros de execução</p><p>Dim retorno, erro</p><p>retorno = Application.UserAdministration( , , False, erro)</p><p>If Not retorno Then</p><p>MsgBox "Erros na edição de usuários: " & erro</p><p>End If</p><p>End Sub</p><p>IMPORTANTE</p><p>Apenas administradores e usuários com a permissão Configurar usuários/grupos habilitada, disponível no item</p><p>Domínios da aba Permissões da janela de edição de usuários, têm acesso à caixa de diálogo aberta por este</p><p>método.</p><p>4.1.3 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Viewer.</p><p>4.1.3.1 AllowContextMenu</p><p>Se configurada em Verdadeiro, esta propriedade habilita a exibição do menu contextual das Telas através do botão</p><p>direito do mouse em tempo de execução, exceto quando algum script está configurado com informação divergente</p><p>nos eventos MouseDown ou MouseUp. Caso contrário, o menu contextual não é mostrado. O valor padrão desta</p><p>propriedade é Verdadeiro.</p><p>NOTA</p><p>Em aplicações anteriores à versão 5.1, o comportamento desta propriedade é configurado pela propriedade</p><p>EnableZoomMenu, que foi descontinuada. Ao abrir estas aplicações na versão atual, o comportamento anterior é</p><p>atualizado para esta propriedade.</p><p>4.1.3.2 AllowZoomChange</p><p>Esta propriedade habilita a exibição ou não das opções de alteração do nível de zoom no menu contextual das</p><p>Telas. O valor padrão desta propriedade é Verdadeiro.</p><p>4.1.3.3 BlinkTime</p><p>Define o tempo, em milissegundos, entre cada mudança de estado quando um objeto tem que piscar, ou seja, toda</p><p>vez que algum objeto de Tela tem uma Associação e é selecionada a opção Piscar. O valor padrão desta propriedade</p><p>é 200 ms.</p><p>77</p><p>Visualização</p><p>NOTA</p><p>O tempo mínimo de atualização da Tela é 55 ms. Portanto, se esta propriedade é configurada com um tempo</p><p>inferior, esta configuração não tem efeito algum.</p><p>4.1.3.4 CacheEnable</p><p>Mantém em memória as Telas já abertas instanciadas no Elipse E3 Viewer, permitindo uma troca mais rápida entre</p><p>estas Telas. Se esta propriedade está habilitada, então o cache de Telas também é habilitado.</p><p>4.1.3.5 Caption</p><p>Determina o nome da aplicação que está utilizando o Elipse E3 Viewer. O valor padrão desta propriedade é uma</p><p>String vazia.</p><p>4.1.3.6 CenterWindow</p><p>Quando habilitada, determina que a janela de visualização do Elipse E3 Viewer deve iniciar centralizada. Caso</p><p>contrário, é utilizada a configuração padrão. O valor padrão desta propriedade é Verdadeiro.</p><p>4.1.3.7 CloseButton</p><p>Se esta propriedade está configurada como Verdadeiro, o botão Fechar é habilitado no Elipse E3 Viewer, e é</p><p>possível utilizar este botão. Caso contrário, este botão não aparece na janela. O valor padrão desta propriedade é</p><p>Verdadeiro.</p><p>4.1.3.8 CommErrorBkColor</p><p>Propriedade utilizada para definir a cor de fundo de um SetPoint quando uma Associação ou Conexão falha. O valor</p><p>padrão desta propriedade é vermelho (RGB(255, 0, 0)). Consulte a propriedade EnableCommError para mais</p><p>informações. Esta propriedade não pode ser alterada em tempo de execução, mesmo que o Elipse E3 Viewer esteja</p><p>inativo.</p><p>4.1.3.9 CommErrorText</p><p>Propriedade utilizada para definir o texto de alerta quando uma Associação ou Conexão falha. O valor padrão desta</p><p>propriedade é "???". Consulte a propriedade EnableCommError para mais informações. Esta propriedade não pode</p><p>ser alterada em tempo de execução, mesmo que o Elipse E3 Viewer esteja inativo.</p><p>4.1.3.10 CommErrorTextColor</p><p>Propriedade utilizada para definir a cor do texto de um SetPoint quando uma Associação ou Conexão falha. O valor</p><p>padrão desta propriedade é amarelo (RGB(255, 255, 0)). Consulte a propriedade EnableCommError para mais</p><p>informações. Esta propriedade não pode ser alterada em tempo de execução, mesmo que o Elipse E3 Viewer esteja</p><p>inativo.</p><p>4.1.3.11 DisableTaskSwitching</p><p>Se esta propriedade está configurada para Verdadeiro, desabilita a troca de janelas no Elipse E3 Viewer. Caso</p><p>contrário, a troca de janelas é habilitada. O valor padrão desta propriedade é Falso. Esta propriedade pode ser</p><p>modificada em tempo de execução utilizando o método SetDisableTaskSwitching.</p><p>4.1.3.12 EnableCommError</p><p>Habilita ou desabilita a visualização dos erros de comunicação. Por exemplo, caso haja na Tela um SetPoint</p><p>associado a um Tag de Comunicação, e a comunicação do Elipse E3 com este Tag falhe, é mostrado no SetPoint o</p><p>texto configurado na propriedade CommErrorText, com a cor informada na propriedade CommErrorTextColor e a</p><p>cor de fundo do SetPoint definida na propriedade CommErrorBkColor. O valor padrão desta propriedade é</p><p>Verdadeiro. Esta propriedade não pode ser alterada em tempo de execução, mesmo que o Elipse E3 Viewer esteja</p><p>inativo.</p><p>4.1.3.13 EnableHeartbeat</p><p>Habilita ou desabilita o envio de uma mensagem de heartbeat (enviada em intervalos fixos, que indica que o</p><p>servidor está ativo) entre o Elipse E3 Viewer e o servidor. Caso o Elipse E3 Viewer pare de receber as mensagens de</p><p>Visualização</p><p>78</p><p>heartbeat, é sinal de que algum problema ocorreu, portanto a conexão deve ser abortada. O valor padrão desta</p><p>propriedade é Falso.</p><p>4.1.3.14 EnableInactivity</p><p>Habilita ou desabilita a verificação do período de inatividade de um usuário. Para mais informações, consulte o</p><p>evento OnInactive do objeto Viewer. O valor padrão desta propriedade é Falso. Esta propriedade não pode ser</p><p>alterada com o objeto ativo.</p><p>4.1.3.15 HeartbeatPeriodMs</p><p>Indica o intervalo, em milissegundos, entre as mensagens de heartbeat enviadas pelo Servidor. A mensagem de</p><p>heartbeat sempre é enviada quando o servidor permanece pelo período indicado por esta propriedade sem enviar</p><p>nenhuma mensagem para o Elipse E3 Viewer. O valor padrão desta propriedade é 2000 (dois segundos).</p><p>4.1.3.16 HeartbeatTimeoutMs</p><p>Indica o tempo, em milissegundos, que o Elipse E3 Viewer tolera sem receber nenhuma mensagem do Servidor. Se</p><p>este tempo passa e nenhuma mensagem é recebida, o Elipse E3 Viewer assume que a conexão foi perdida e inicia o</p><p>processo de reconexão. Este tempo deve ser maior que o tempo determinado na propriedade HeartbeatPeriodMs,</p><p>de preferência maior que o dobro. O valor padrão desta propriedade é 5000 (cinco segundos).</p><p>4.1.3.17 InactivityTime</p><p>Define o tempo máximo de espera por um evento de mouse ou de teclado antes do período de inatividade, em</p><p>minutos. Para mais informações, consulte o evento OnInactive do objeto Viewer. O valor padrão desta propriedade é</p><p>5 (cinco) minutos. O código a seguir contém um exemplo de uso desta propriedade.</p><p>Sub CommandButton3_Click()</p><p>MsgBox "A aplicação ficará inativa em " & _</p><p>Application.InactivityTime & " minuto(s)."</p><p>End Sub</p><p>4.1.3.18 InitialScreen</p><p>Indica a Tela ou Quadro inicial que deve ser mostrado</p><p>quando o Elipse E3 Viewer é aberto. Através da propriedade</p><p>WindowStyle é possível determinar se a janela deve iniciar maximizada, janelada ou minimizada. O valor padrão</p><p>desta propriedade é "TelaInicial". Para utilizar esta propriedade em scripts, consulte a propriedade SplitLink do</p><p>Divisor para mais informações sobre o formato para especificar uma Tela nesta propriedade.</p><p>4.1.3.19 IsPlaybackMode</p><p>Se esta propriedade está configurada para Verdadeiro, indica que o Elipse E3 Viewer está em execução dentro de</p><p>um E3Playback, em modo playback. Esta propriedade é somente de leitura.</p><p>4.1.3.20 IsReadOnly</p><p>Se esta propriedade está configurada para Verdadeiro, indica que o Elipse E3 Viewer está no modo Somente</p><p>Leitura, ou acesso restrito. Esta propriedade é somente de leitura.</p><p>4.1.3.21 IsWebView2Enabled</p><p>Indica se está habilitado ou não o uso do controle WebView2 do Microsoft Edge como mecanismo de renderização</p><p>para exibição de conteúdo da Internet. Esta propriedade é somente de leitura.</p><p>4.1.3.22 LoginRetries</p><p>Especifica o número de retentativas de login do Elipse E3 Viewer, isto é, quantas vezes a caixa de diálogo de login é</p><p>exibida além da primeira vez. O valor padrão desta propriedade é 2 (dois).</p><p>4.1.3.23 MaximizeButton</p><p>Se esta propriedade está configurada para Verdadeiro, o botão Maximizar é habilitado no Elipse E3 Viewer e é</p><p>possível utilizar este botão. Caso contrário, este botão não aparece na janela. O valor padrão desta propriedade é</p><p>Verdadeiro.</p><p>https://developer.microsoft.com/pt-br/microsoft-edge/webview2/</p><p>79</p><p>Visualização</p><p>4.1.3.24 MinimizeButton</p><p>Se esta propriedade está configurada para Verdadeiro, o botão Minimizar é habilitado no Elipse E3 Viewer e é</p><p>possível utilizar este botão. Caso contrário, este botão não aparece na janela. O valor padrão desta propriedade é</p><p>Verdadeiro.</p><p>4.1.3.25 Params</p><p>Esta propriedade é um vetor de pares chave-valor que retorna os parâmetros passados para o Elipse E3 Viewer</p><p>através da opção de linha de comando -params. Todos os valores são retornados como Strings. Por exemplo, se a</p><p>linha de comando do Elipse E3 Viewer contiver os seguintes parâmetros:</p><p>Viewer -params Idioma=PTB</p><p>Pode-se utilizar o seguinte código para verificar qual o idioma de inicialização do Elipse E3 Viewer.</p><p>Sub TelaInicial_OnStartRunning()</p><p>Select Case Application.Params("Idioma")</p><p>Case "PTB"</p><p>Item("Texto1").Value = "Português do Brasil"</p><p>Case Else</p><p>Item("Texto1").Value = "Idioma não reconhecido"</p><p>End Select</p><p>End Sub</p><p>NOTA</p><p>A String da chave não diferencia entre maiúsculas e minúsculas, pode ser tanto "idioma" quanto "Idioma", mas os</p><p>valores retornados, principalmente se utilizados com uma instrução Select, diferenciam entre maiúsculas e</p><p>minúsculas.</p><p>4.1.3.26 ProductString</p><p>Esta propriedade contém uma String com o nome do produto e a versão do Elipse E3 Viewer, como por exemplo</p><p>"Elipse E3 6.7.234". Esta propriedade é somente de leitura.</p><p>Note que o Elipse E3 Viewer pode acessar um objeto no Servidor e recuperar a propriedade ProductString daquele</p><p>Servidor, conforme o exemplo a seguir.</p><p>Set servidor = Application.GetObject("ServidorDados").Application</p><p>MsgBox "Versão do Servidor: " & servidor.ProductString</p><p>No exemplo anterior, considerando-se que o objeto ServidorDados está em um Servidor, o texto mostrado na caixa</p><p>de diálogo é "Versão do Servidor: Elipse E3 6.7.234" ou "Versão do Servidor: Elipse E3 (64-bits) 6.7.234".</p><p>4.1.3.27 ProductVersionBuild</p><p>Esta propriedade contém o número de build da versão do Elipse E3 Viewer. Por exemplo, se a versão instalada é a</p><p>6.7.234, esta propriedade contém o valor 234. Esta propriedade é somente de leitura.</p><p>4.1.3.28 ProductVersionMajor</p><p>Esta propriedade contém o número principal da versão do Elipse E3 Viewer. Por exemplo, se a versão instalada é a</p><p>6.7.234, esta propriedade contém o valor 6. Esta propriedade é somente de leitura.</p><p>4.1.3.29 ProductVersionMinor</p><p>Esta propriedade contém o número secundário da versão do Elipse E3 Viewer. Por exemplo, se a versão instalada é</p><p>a 6.7.234, esta propriedade contém o valor 7. Esta propriedade é somente de leitura.</p><p>4.1.3.30 ReconnectDialogDelaySec</p><p>Indica o número de segundos que o Elipse E3 Viewer espera durante uma possível reconexão ao servidor antes de</p><p>mostrar uma mensagem avisando o usuário desta ação. Esta propriedade não afeta a primeira conexão. Se o valor</p><p>desta propriedade é igual a 0 (zero), a mensagem de reconexão sempre é mostrada. Para evitar que a mensagem</p><p>seja mostrada, é recomendável colocar um número muito grande, como por exemplo um bilhão.</p><p>Visualização</p><p>80</p><p>NOTA</p><p>Quando a reconexão ocorre em silêncio, todas as janelas do Elipse E3 Viewer ativo são desabilitadas e uma</p><p>ampulheta é mostrada, indicando que a aplicação está indisponível. Durante o tempo da reconexão, não é permitido</p><p>ao usuário cancelar o processo.</p><p>4.1.3.31 RenderQuality</p><p>Controla a qualidade de desenho de todas as Telas, somente se o valor da propriedade RenderQuality das Telas</p><p>é igual a 0 - rqDefault. Os valores possíveis para esta propriedade são:</p><p>· 0 - rqDefault: Utiliza o modo de qualidade normal, GDI (Graphics Device Interface). Corresponde ao item Utilizar</p><p>Padrão do menu contextual Qualidade (todas as telas) do Elipse E3 Viewer, em tempo de execução. Este é o</p><p>valor padrão para aplicações criadas em versões anteriores à 4.0</p><p>· 1 - rqNormal: Força o modo de qualidade normal (GDI) para o desenho de todas as Telas. Corresponde ao item</p><p>Forçar Qualidade Normal do menu contextual Qualidade (todas as telas) do Elipse E3 Viewer, em tempo de</p><p>execução</p><p>· 2 - rqHighQuality: Força o modo de alta qualidade (GDI+) para o desenho de todas as Telas. Corresponde ao</p><p>item Forçar Alta Qualidade do menu contextual Qualidade (todas as telas) do Elipse E3 Viewer, em tempo de</p><p>execução. Este é o valor padrão para aplicações criadas a partir da versão 4.0</p><p>A figura a seguir mostra o menu contextual do Elipse E3 Viewer em tempo de execução, com as respectivas opções</p><p>de configuração desta propriedade.</p><p>Opções da propriedade RenderQuality do Elipse E3 Viewer</p><p>81</p><p>Visualização</p><p>4.1.3.32 ScreenAlignment</p><p>Controla o alinhamento, dado pelo Elipse E3 Viewer, para as Telas que não especificam um valor diferente do</p><p>padrão. Os valores possíveis para esta propriedade são:</p><p>· 1 - paTopLeft: Ajusta a Tela ao canto superior esquerdo em relação à área visível. Corresponde à opção Forçar</p><p>Superior Esquerdo do menu contextual Alinhamento (Esta Tela) da Tela, em tempo de execução</p><p>· 2 - paCenter: Ajusta a Tela ao centro em relação à área visível. Corresponde à opção Forçar Centralizado do</p><p>menu contextual Alinhamento (Esta Tela) da Tela, em tempo de execução</p><p>A figura a seguir mostra o menu contextual do Elipse E3 Viewer em tempo de execução, com as respectivas opções</p><p>de configuração desta propriedade.</p><p>Opções da propriedade ScreenAlignment do Elipse E3 Viewer</p><p>4.1.3.33 ShowKeyPadOnEdit</p><p>Esta propriedade automaticamente habilita a exibição do Elipse KeyPad, sempre que um objeto de Tela que</p><p>permita edição receba o foco.</p><p>4.1.3.34 TargetDPIX</p><p>Define o valor de pontos por polegada, na horizontal, do monitor do computador de destino. O valor padrão desta</p><p>propriedade é -1 (menos um), que assume o valor do computador atual. Esta propriedade não pode ser alterada em</p><p>tempo de execução, mesmo que o Elipse E3 Viewer esteja inativo.</p><p>Visualização</p><p>82</p><p>4.1.3.35 TargetDPIY</p><p>Define o valor de pontos por polegada, na vertical,</p><p>do monitor do computador de destino. O valor padrão desta</p><p>propriedade é -1 (menos um), que assume o valor do computador atual. Esta propriedade não pode ser alterada em</p><p>tempo de execução, mesmo que o Elipse E3 Viewer esteja inativo.</p><p>4.1.3.36 TargetMarginX</p><p>Define o número de pixels que devem ser descontados da resolução horizontal da Tela, ou seja, a área útil do Elipse</p><p>E3 Viewer. O valor padrão desta propriedade é -1 (menos um), que assume a configuração da janela do Elipse E3</p><p>Viewer (com ou sem a barra de título, com ou sem borda) em conjunto com a configuração do computador atual</p><p>(largura de borda e barra de título definidas pelo Windows). Esta propriedade não pode ser alterada em tempo de</p><p>execução, mesmo que o Elipse E3 Viewer esteja inativo.</p><p>4.1.3.37 TargetMarginY</p><p>Define o número de pixels que devem ser descontados da resolução vertical da Tela, ou seja, a área útil do Elipse</p><p>E3 Viewer. O valor padrão desta propriedade é -1 (menos um), que assume a configuração da janela do Elipse E3</p><p>Viewer (com ou sem a barra de título, com ou sem borda) em conjunto com a configuração do computador atual</p><p>(largura de borda e barra de título definidas pelo Windows). Esta propriedade não pode ser alterada em tempo de</p><p>execução, mesmo que o Elipse E3 Viewer esteja inativo.</p><p>4.1.3.38 TargetResolutionX</p><p>Define a resolução horizontal da Tela para a qual esta aplicação está destinada, em pixels. O valor padrão desta</p><p>propriedade é -1 (menos um), que assume a resolução do computador atual. Esta propriedade não pode ser alterada</p><p>em tempo de execução, mesmo que o Elipse E3 Viewer esteja inativo.</p><p>4.1.3.39 TargetResolutionY</p><p>Define a resolução vertical da Tela para a qual esta aplicação está destinada, em pixels. O valor padrão desta</p><p>propriedade é -1 (menos um), que assume a resolução do computador atual. Esta propriedade não pode ser alterada</p><p>em tempo de execução, mesmo que o Elipse E3 Viewer esteja inativo.</p><p>4.1.3.40 TitleBar</p><p>Se esta propriedade está habilitada, a barra de título do Elipse E3 Viewer é mostrada, conforme as especificações</p><p>da propriedade Caption. Do contrário, a barra de título é escondida. O valor padrão desta propriedade é</p><p>Verdadeiro.</p><p>4.1.3.41 User</p><p>Contém o nome do usuário que está utilizando o Elipse E3 Viewer. Esta propriedade é somente de leitura.</p><p>4.1.3.42 ViewerLanguageId</p><p>Retorna o código do idioma do Elipse E3 Viewer em execução. Os valores possíveis para esta propriedade estão</p><p>descritos na tabela a seguir. Esta propriedade é somente de leitura.</p><p>Valores disponíveis para a propriedade ViewerLanguageId</p><p>DECIMAL HEXADECIMAL IDIOMA</p><p>4 0x0004 Chinês Simplificado</p><p>1031 0x0407 Alemão</p><p>1033 0x0409 Inglês Americano</p><p>1046 0x0416 Português do Brasil</p><p>11274 0x2C0A Espanhol da Argentina</p><p>NOTA</p><p>Esta propriedade NÃO corresponde ao idioma de instalação do Windows e nem ao idioma configurado no painel</p><p>de controle Opções Regionais e de Idioma (Relógio, Idioma e Região no Windows 7) do Windows.</p><p>83</p><p>Visualização</p><p>4.1.3.43 WindowBorder</p><p>Habilita ou desabilita uma borda na janela do Elipse E3 Viewer. O valor padrão desta propriedade é Verdadeiro.</p><p>Esta propriedade é de leitura e escrita, mas alterar o valor em tempo de execução não altera a configuração do</p><p>Elipse E3 Viewer já aberto, apenas das janelas que são abertas utilizando a configuração do Elipse E3 Viewer.</p><p>4.1.3.44 WindowHeight</p><p>Determina a altura da janela do Elipse E3 Viewer, em pixels. O valor padrão desta propriedade é 300.</p><p>4.1.3.45 WindowMovable</p><p>Indica se a janela pode ser movida. O valor padrão desta propriedade é Verdadeiro. Esta propriedade é de leitura</p><p>e escrita, mas alterar o valor em tempo de execução não altera a configuração do Elipse E3 Viewer já aberto, apenas</p><p>das janelas que são abertas utilizando a configuração do Elipse E3 Viewer.</p><p>4.1.3.46 WindowResizable</p><p>Indica se a janela pode ser redimensionada. Esta propriedade só tem efeito se a propriedade WindowBorder é</p><p>igual a Verdadeiro. O valor padrão desta propriedade é Verdadeiro. Esta propriedade é de leitura e escrita, mas</p><p>alterar o valor em tempo de execução não altera a configuração do Elipse E3 Viewer já aberto, apenas das janelas</p><p>que são abertas utilizando a configuração do Elipse E3 Viewer.</p><p>4.1.3.47 WindowSmallTitle</p><p>Indica se a janela do Elipse E3 Viewer deve ter a barra de título pequena. Esta propriedade só tem efeito se a</p><p>propriedade TitleBar é igual a Verdadeiro. O valor padrão desta propriedade é Falso. Esta propriedade é de leitura e</p><p>escrita, mas alterar o valor em tempo de execução não altera a configuração do Elipse E3 Viewer já aberto, apenas</p><p>das janelas que são abertas utilizando a configuração do Elipse E3 Viewer.</p><p>4.1.3.48 WindowStayOnTop</p><p>Indica se a janela do Elipse E3 Viewer deve sempre se sobrepor às outras janelas. O valor padrão desta</p><p>propriedade é Falso. Esta propriedade é de leitura e escrita, mas alterar o valor em tempo de execução não altera a</p><p>configuração do Elipse E3 Viewer já aberto, apenas das janelas que são abertas utilizando a configuração do Elipse</p><p>E3 Viewer.</p><p>4.1.3.49 WindowStyle</p><p>Define o estilo inicial de janela do Elipse E3 Viewer. Os valores possíveis para esta propriedade são 0 -</p><p>Maximized: Inicia o Elipse E3 Viewer maximizado (padrão), 1 - Windowed: Inicia o Elipse E3 Viewer janelado ou 2 -</p><p>Minimized: Inicia o Elipse E3 Viewer minimizado.</p><p>4.1.3.50 WindowWidth</p><p>Determina a largura da janela do Elipse E3 Viewer, em pixels. O valor padrão desta propriedade é 400.</p><p>4.2 Quadros e Divisores</p><p>Esta seção contém informações sobre métodos e propriedades do objeto Divisor (FrameSet) e sobre as</p><p>propriedades do objeto Quadro (Frame). O objeto Divisor não possui eventos associados e o objeto Quadro não</p><p>possui eventos nem métodos associados.</p><p>4.2.1 Métodos do Divisor</p><p>Esta seção contém informações sobre os métodos do objeto Divisor (FrameSet).</p><p>4.2.1.1 BringToFront</p><p>BringToFront()</p><p>Traz para a frente um Divisor que esteja escondido ou abaixo de outro Divisor.</p><p>Visualização</p><p>84</p><p>4.2.1.2 CaptureScreen</p><p>CaptureScreen(Filename)</p><p>Captura o conteúdo de um Divisor, gravando-o no arquivo de nome e caminho Filename no formato BMP, conforme o</p><p>exemplo a seguir.</p><p>Sub CommandButton1_Click()</p><p>' Ao clicar neste Botão, copia o conteúdo</p><p>' do Divisor para o arquivo frame.bmp</p><p>Screen.Frame.CaptureScreen("c:\temp\frame.bmp")</p><p>End Sub</p><p>4.2.1.3 Close</p><p>Close(Code)</p><p>Utilize este método para fechar a janela do Quadro. O parâmetro Code tem o valor de retorno para o método</p><p>DoModal, se a janela em questão é chamada por este método, conforme o exemplo a seguir.</p><p>Sub BotaoFecha_Click()</p><p>' Ao clicar neste Botão, fecha a janela</p><p>Screen.Close(0)</p><p>End Sub</p><p>4.2.1.4 FlashWindow</p><p>FlashWindow(Number, Time)</p><p>Este método permite que o ícone do Elipse E3 Viewer comece a piscar na Área de Notificações do Windows. O</p><p>parâmetro Number determina o número de vezes que o ícone deve piscar e Time determina o tempo, em</p><p>milissegundos, entre um piscar e outro, conforme o exemplo a seguir.</p><p>Sub Texto1_Click()</p><p>Set quadro = Application.GetFrame("_top")</p><p>quadro.FlashWindow 50, 500</p><p>End Sub</p><p>4.2.1.5 MaximizeFrame</p><p>MaximizeFrame()</p><p>Maximiza um Quadro ou Tela modal.</p><p>4.2.1.6 MinimizeFrame</p><p>MinimizeFrame()</p><p>Minimiza um Quadro ou Tela modal.</p><p>4.2.1.7 MoveFrame</p><p>MoveFrame([PosX], [PosY], [SizeX], [SizeY])</p><p>Move e redimensiona um Divisor (Frame) para uma coordenada e um tamanho específicos. Os parâmetros PosX e</p><p>PosY informam a nova posição, em pixels, com relação à esquerda e ao topo, respectivamente. Os parâmetros SizeX e</p><p>SizeY informam o novo comprimento e a nova altura, respectivamente, em pixels ou em Himetric. Todos os parâmetros</p><p>são opcionais e, se omitidos, não movem, no caso dos parâmetros PosX e PosY, e nem redimensionam, no caso dos</p><p>parâmetros SizeX</p><p>e SizeY, o Divisor, conforme o exemplo a seguir.</p><p>Sub Tela2_OnPreShow(vArg)</p><p>' Quando a Tela2 é aberta no Divisor Teste, altera a posição</p><p>' e o tamanho do Divisor</p><p>Application.GetFrame("Teste").MoveFrame 100, 100, 200, 200</p><p>End Sub</p><p>NOTA</p><p>Os valores de tamanho neste método podem ser informados como números ou Strings. No caso de números, são</p><p>considerados em pixels. No caso de Strings, se vierem acompanhados da unidade "hm", são interpretados como</p><p>Himetric. Qualquer outro caso é considerado em pixels.</p><p>85</p><p>Visualização</p><p>4.2.1.8 NavigateBack</p><p>NavigateBack()</p><p>Volta para a Tela anterior no histórico de navegação do Divisor, se a propriedade NavigateCanGoBack é Verdadeira.</p><p>4.2.1.9 NavigateForward</p><p>NavigateForward()</p><p>Avança para a Tela seguinte no histórico de navegação do Divisor, se a propriedade NavigateCanGoForward é</p><p>Verdadeira.</p><p>4.2.1.10 NavigateHistReset</p><p>NavigateHistReset()</p><p>Limpa o histórico de abertura de Telas do Divisor, indicado pela propriedade NavigateHistCount.</p><p>4.2.1.11 OpenScreen</p><p>OpenScreen(ScreenName, Arg)</p><p>Este método abre uma Tela dentro de um Divisor. O parâmetro ScreenName determina a Tela a ser aberta, além de</p><p>ser possível especificar algumas propriedades desta Tela. Consulte a propriedade SplitLink do Divisor para mais</p><p>informações sobre o formato para especificar uma Tela neste parâmetro. O parâmetro Arg permite especificar um</p><p>valor a ser repassado à Tela através do evento OnPreShow, como no exemplo a seguir.</p><p>Sub Botao1_Click()</p><p>'Clicar neste Botão abre a Tela2 no Frame Teste,</p><p>'zoom de 100%, sem barra de rolagem</p><p>'e alinhamento padrão em relação à área visível</p><p>'Também passa uma String para o evento OnPreShow</p><p>Application.GetFrame("Teste")._</p><p>OpenScreen "Tela2?100?0?0", "Isto é um teste."</p><p>End Sub</p><p>Sub Tela2_OnPreShow(vArg)</p><p>'A caixa de mensagem mostra</p><p>'a frase "Isto é um teste."</p><p>MsgBox vArg</p><p>End Sub</p><p>4.2.1.12 Refresh</p><p>Refresh([Force])</p><p>Este método permite forçar o redesenho do conteúdo de uma Tela ou Divisor. Este método deve ser usado em scripts</p><p>do Elipse E3 Viewer com processamento massivo, como por exemplo em laços, ou em chamadas de métodos que</p><p>demandem muito tempo e exijam indicações visuais ao usuário do progresso do processo.</p><p>Devido ao redesenho em geral ser uma operação pesada, a versão padrão deste método, sem o parâmetro Force, é</p><p>otimizada de forma a ignorar pedidos de redesenho muito próximos, incluindo redesenho do próprio Elipse E3. Este</p><p>comportamento padrão é ideal para indicações de progresso em laços, onde muitos redesenhos são realizados em</p><p>sequência. O parâmetro Force desabilita esta otimização, garantindo que para cada chamada deste método seja</p><p>realizado um redesenho. Porém, ao utilizar-se esta opção, este método não pode ser chamado repetidamente, como</p><p>dentro de um laço, conforme o exemplo a seguir.</p><p>Sub CommandButton1_Click()</p><p>' Desenha uma barra de progresso de uma operação</p><p>While i < 31</p><p>Screen.Item("Retangulo2")_</p><p>.HorizontalPercentFill = (i / 30) * 100</p><p>Frame.Refresh True</p><p>' <-- alguma operação demorada --></p><p>Wend</p><p>End Sub</p><p>4.2.1.13 RestoreFrame</p><p>RestoreFrame()</p><p>Permite restaurar a janela do Quadro para o tamanho original.</p><p>Visualização</p><p>86</p><p>4.2.1.14 SetDisableTaskSwitching</p><p>SetDisableTaskSwitching(Disable)</p><p>Habilita ou desabilita a troca de janelas. O parâmetro Disable é um valor Booleano que indica se a troca de janelas é</p><p>habilitada ou não. Este método atualiza a propriedade DisableTaskSwitching do objeto Viewer.</p><p>NOTAS</p><p>· Se mais de uma instância do Elipse E3 Viewer está executando em um mesmo computador, e pelo menos uma</p><p>destas instâncias utiliza este método, a alteração afeta todos os Elipse E3 Viewers deste computador.</p><p>· Caso seja necessário modificar o título ou o estilo da janela, o método SetFrameOptions deve ser utilizado após a</p><p>chamada a este método.</p><p>4.2.1.15 SetForegroundWnd</p><p>SetForegroundWnd()</p><p>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</p><p>operador para algum evento ocorrido, quando a janela do Elipse E3 Viewer encontra-se escondida ou minimizada.</p><p>4.2.1.16 SetFrameOptions</p><p>SetFrameOptions(Title, [Flags])</p><p>Este método é utilizado para configurar o título do Quadro na janela e o estilo da janela. O parâmetro Title é uma</p><p>String que contém o título da janela. Este texto é mostrado se a propriedade Caption da Tela está vazia.</p><p>O parâmetro Flags especifica o estilo da janela. Se este parâmetro é omitido, o valor padrão é -1 (menos um). Este</p><p>valor é usado para manter a configuração anterior da janela. Quando o valor especificado não é igual a -1 (menos</p><p>um), pode-se modificar o estilo da janela especificando a soma dos valores das combinações descritas na tabela a</p><p>seguir.</p><p>Combinações possíveis para o parâmetro Flags</p><p>VALOR DESCRIÇÃO</p><p>1 Habilita a barra de título na janela</p><p>2 Habilita o botão Fechar na janela</p><p>4 Habilita o botão Minimizar na janela</p><p>8 Habilita o botão Maximizar na janela</p><p>16 Habilita a borda na janela</p><p>32 Especifica que a janela pode ser dimensionada. Para isto,</p><p>é necessário que a janela tenha uma borda</p><p>64 Especifica que a janela pode ser movida</p><p>256 Especifica que a janela fica no topo da Tela</p><p>512 Especifica que a janela é configurada no estilo Barra de</p><p>Ferramentas</p><p>1024 Desabilita os botões de objeto</p><p>2048 Centraliza a janela</p><p>Exemplo:</p><p>Sub Tela_OnPreShow()</p><p>Frame.SetFrameOptions("Tela de Alarmes", 114)</p><p>End Sub</p><p>No exemplo anterior, o valor 114 (2 + 16 + 32 + 64) indica que a janela tem um botão Fechar habilitado (2), uma</p><p>borda (16), pode ser dimensionada (32) e pode ser movida (64). O título da janela é "Tela de Alarmes".</p><p>Nos Picks Abrir Tela e Abrir Tela Modal também é possível configurar o estilo da janela durante a edição, através da</p><p>caixa de diálogo Estilo da Janela. Para mais informações, consulte o tópico Picks.</p><p>87</p><p>Visualização</p><p>NOTA</p><p>Este método deve ser usado após a chamada ao método SetDisableTaskSwitching, caso seja necessário modificar</p><p>o título ou o estilo da janela.</p><p>4.2.1.17 ShowScreen</p><p>ShowScreen(Screen, [Zoom], [Scrollbars], [Arg], [Alignment])</p><p>Este método carrega uma Tela no Divisor, fechando a Tela ou Quadro carregado anteriormente. Os parâmetros</p><p>disponíveis neste método são os seguintes:</p><p>· Screen: O objeto Tela a ser carregado. Este objeto deve ser retornado pelo método GetScreen do Viewer</p><p>· Zoom: Percentual de zoom da Tela. Se omitido, assume o valor 100</p><p>· Scrollbars: Booleano que indica se a barra de rolagem da Tela deve ou não estar habilitada. Se omitido, não</p><p>habilita a barra de rolagem da Tela</p><p>· Arg: String cujo valor é usado no evento OnPreShow da Tela a ser carregada. Se omitido, não passa nenhum</p><p>valor para a Tela a ser carregada</p><p>· Alignment: Indica se a Tela deve ter um alinhamento superior esquerdo (1, um) ou um alinhamento centralizado</p><p>(2, dois) em relação à área visível. Se este parâmetro é omitido ou se o valor informado é inválido, assume o</p><p>valor 0 (zero, comportamento padrão da Tela)</p><p>A propriedade SplitLink é atualizada após a chamada deste método.</p><p>NOTA</p><p>O parâmetro Screen somente aceita o objeto retornado pelo método GetScreen do Viewer. Este método falha caso</p><p>seja utilizado um objeto Tela obtido a partir de outro método ou propriedade, como por exemplo a propriedade</p><p>Screen, comum a todos os objetos de Tela.</p><p>4.2.2 Propriedades do Divisor</p><p>Esta seção contém informações sobre as propriedades do objeto Divisor (FrameSet).</p><p>4.2.2.1 IsHTML</p><p>Esta propriedade retorna Verdadeiro se o Divisor contém código HTML inserido no Quadro ou Falso caso</p><p>contrário. Esta propriedade é somente de leitura.</p><p>4.2.2.2 NavigateCanGoBack</p><p>Indica se é possível usar o método NavigateBack no Divisor. Esta propriedade é somente de leitura.</p><p>4.2.2.3 NavigateCanGoForward</p><p>Indica se é possível usar o método NavigateForward no Divisor. Esta propriedade é somente de leitura.</p><p>4.2.2.4 NavigateHistCount</p><p>Informa o número de Telas disponíveis no histórico de navegação do Divisor. Esta propriedade é somente de leitura.</p><p>O histórico de navegação de um Divisor tem um limite máximo de aproximadamente 100 Telas. Após atingir este</p><p>limite, as Telas mais antigas vão sendo descartadas.</p><p>4.2.2.5 SplitBorder</p><p>Habilita ou desabilita a borda do Divisor e determina se a borda entre o Divisor mandante e o Divisor restante deve</p><p>ser exibida em tempo de execução. Esta propriedade não tem efeito no Divisor restante. O valor padrão desta</p><p>propriedade é Verdadeiro.</p><p>Visualização</p><p>88</p><p>4.2.2.6 SplitDockPosition</p><p>Indica a posição do Divisor desejado na Tela. As opções disponíveis estão descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade SplitDockPosition</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - dockRemaining Posiciona o Divisor como restante, ou seja, ocupa o</p><p>espaço que sobra na Divisão horizontal ou vertical</p><p>(padrão)</p><p>1 - dockTop Posiciona o Divisor como mandante, acima do restante</p><p>2 - dockBottom Posiciona o Divisor como mandante, abaixo do restante</p><p>3 - dockLeft Posiciona o Divisor como mandante, à esquerda do</p><p>restante</p><p>4 - dockRight Posiciona o Divisor como mandante, à direita do restante</p><p>Esta propriedade não pode ser alterada em tempo de execução, mesmo que o Divisor esteja inativo.</p><p>4.2.2.7 SplitLink</p><p>Esta propriedade contém um link que deve ser mostrado no Divisor. Pode-se especificar uma Tela do projeto, um</p><p>executável ou um link na Internet. No caso de Telas, é possível especificar um percentual de zoom, habilitar as barras</p><p>de rolagem e alinhar a Tela na área visível usando como separador um ponto de interrogação no formato "<nome-</p><p>da-tela>?<zoom>?<barra-de-rolagem>?<alinhamento>". Os valores possíveis para os parâmetros desta</p><p>propriedade estão descritos a seguir.</p><p>· <nome-da-tela>: Este parâmetro é obrigatório e indica o nome de uma Tela, um executável ou um link na</p><p>Internet a ser aberto no Divisor</p><p>· <zoom>: Este parâmetro é opcional e indica o percentual de zoom da Tela a ser aberta no Divisor. Se este</p><p>parâmetro não é informado, assume o valor de 100%</p><p>· <barra-de-rolagem>: Este parâmetro é opcional e indica se a Tela deve habilitar (1, um) ou desabilitar (0, zero) a</p><p>barra de rolagem. Se este parâmetro não é informado, assume o valor 1 (um, habilitado)</p><p>· <alinhamento>: Este parâmetro é opcional e indica se a Tela deve ter um alinhamento superior esquerdo (1, um)</p><p>ou um alinhamento centralizado (2, dois) em relação à área visível. Se este parâmetro não é informado ou se o</p><p>valor informado é inválido, assume o valor 0 (zero, comportamento padrão da Tela, configurado na propriedade</p><p>ScreenAlignment da Tela a ser aberta)</p><p>Os parâmetros <zoom>, <barra-de-rolagem> e <alinhamento> são válidos apenas se o parâmetro <nome-da-tela> se</p><p>tratar de uma Tela. Do contrário, são ignorados.</p><p>4.2.2.8 SplitResizable</p><p>Determina se o Divisor mandante pode ser redimensionado em tempo de execução. Esta propriedade não tem</p><p>efeito no Divisor restante. O valor padrão desta propriedade é Verdadeiro.</p><p>4.2.2.9 SplitValue</p><p>Esta propriedade determina o valor que é atribuído ao Divisor de um Quadro. Este valor pode ser acompanhado da</p><p>unidade "%" (porcentagem), "hm" (Himetric) ou "px" (pixels). Se a unidade é omitida, o valor é considerado em</p><p>unidades Himetric.</p><p>4.2.3 Propriedades do Quadro</p><p>Esta seção contém informações sobre as propriedades do objeto Quadro (Frame).</p><p>4.2.3.1 Caption</p><p>Esta propriedade define o título do Quadro a ser mostrado na barra de título do Elipse E3 Viewer.</p><p>89</p><p>Visualização</p><p>4.3 Telas e Objetos de Tela</p><p>Esta seção contém informações sobre eventos, métodos e propriedades de Telas e Objetos de Tela.</p><p>4.3.1 Tela</p><p>Esta seção contém informações sobre eventos, métodos e propriedades do objeto Tela (Screen).</p><p>4.3.1.1 Eventos</p><p>Esta seção contém informações sobre os eventos do objeto Tela (Screen).</p><p>4.3.1.1.1 Click</p><p>Click()</p><p>Ocorre quando o botão esquerdo do mouse é pressionado sobre a Tela. Este evento não ocorre se a Tela não estiver</p><p>visível ou sua propriedade Enabled estiver configurada para Falso. A visibilidade da Tela depende de três fatores:</p><p>Propriedade Visible igual a Verdadeiro, objeto pai visível e propriedade Layer do objeto presente na camada da</p><p>Tela.</p><p>4.3.1.1.2 DblClick</p><p>DblClick()</p><p>Ocorre quando há um duplo-clique, ou seja, o botão esquerdo do mouse é pressionado rapidamente duas vezes</p><p>sobre a Tela. Este evento não ocorre se o objeto não estiver visível ou se sua propriedade Enabled estiver</p><p>configurada para Falso. A visibilidade do objeto depende de três fatores: Propriedade Visible igual a Verdadeiro,</p><p>objeto pai visível e propriedade Layer do objeto presente na camada da Tela.</p><p>4.3.1.1.3 KeyDown</p><p>KeyDown(KeyCode, Shift)</p><p>Ocorre no momento em que uma tecla é pressionada, independente do foco na Tela.</p><p>Parâmetros do evento KeyDown</p><p>NOME DESCRIÇÃO</p><p>KeyCode Número inteiro que identifica o caractere ASCII da tecla</p><p>pressionada</p><p>Shift Mostra o atalho de teclado usado juntamente com a</p><p>tecla pressionada. Os valores possíveis para este</p><p>parâmetro são 4: Tecla SHIFT, 8: Tecla CTRL ou 12: Teclas</p><p>CTRL + SHIFT</p><p>O script a seguir contém um exemplo de uso deste evento.</p><p>Sub Tela1_KeyDown(KeyCode, Shift)</p><p>' Mostra uma caixa de mensagem quando</p><p>' o usuário pressiona uma tecla</p><p>MsgBox "Código da tecla: " & KeyCode</p><p>End Sub</p><p>NOTA</p><p>Para uma lista com todos os códigos de tecla disponíveis para o parâmetro KeyCode, consulte o artigo Keys</p><p>Enumeration no Microsoft Developer Network.</p><p>4.3.1.1.4 KeyUp</p><p>KeyUp(KeyCode, Shift)</p><p>Ocorre no momento em que uma tecla é solta, independente do foco na Tela.</p><p>https://msdn.microsoft.com/en-us/library/system.windows.forms.keys(VS.71).aspx</p><p>https://msdn.microsoft.com/en-us/library/system.windows.forms.keys(VS.71).aspx</p><p>Visualização</p><p>90</p><p>Parâmetros do evento KeyUp</p><p>NOME DESCRIÇÃO</p><p>KeyCode Número inteiro que identifica o caractere ASCII da tecla</p><p>pressionada</p><p>Shift Mostra o atalho de teclado usado juntamente com a</p><p>tecla pressionada. Os valores possíveis para este</p><p>parâmetro são 4: Tecla SHIFT, 8: Tecla CTRL ou 12: Teclas</p><p>CTRL + SHIFT</p><p>O script a seguir contém um exemplo de uso deste evento.</p><p>Sub Tela1_KeyUp(KeyCode, Shift)</p><p>' Mostra uma caixa de mensagem quando o usuário</p><p>' soltar uma tecla</p><p>MsgBox "Código da tecla: " & KeyCode</p><p>End Sub</p><p>NOTA</p><p>Para uma lista com todos os códigos de tecla disponíveis para o parâmetro KeyCode, consulte o artigo Keys</p><p>Enumeration no Microsoft Developer Network.</p><p>4.3.1.1.5 MouseDown</p><p>MouseDown(Button, ShiftState, MouseX, MouseY)</p><p>Ocorre quando se pressiona qualquer botão do mouse na Tela. Utilize este evento para determinar ações específicas</p><p>quando a Tela é clicada pelo usuário.</p><p>Parâmetros do evento MouseDown</p><p>NOME DESCRIÇÃO</p><p>Button Mostra o botão do mouse pressionado. Os valores</p><p>possíveis para este parâmetro são 1: O botão do mouse</p><p>pressionado é o esquerdo, 2: O botão do mouse</p><p>pressionado é o direito ou 4: O botão do mouse</p><p>pressionado é o do meio</p><p>ShiftState Mostra a tecla pressionada juntamente com o botão do</p><p>mouse. Os valores possíveis para este parâmetro são 4:</p><p>Tecla SHIFT, 8: Tecla CTRL ou 12: Teclas CTRL + SHIFT</p><p>MouseX Mostra a coordenada X onde o ponteiro do mouse foi</p><p>clicado na Tela</p><p>MouseY Mostra a coordenada Y onde o ponteiro do mouse foi</p><p>clicado na Tela</p><p>O script a seguir contém um exemplo de uso deste evento.</p><p>Sub</p><p>TelaInicial_MouseDown(Button, ShiftState, MouseX, MouseY)</p><p>' Encerra a aplicação quando houver um clique de mouse</p><p>' no objeto TelaInicial.</p><p>Application.Exit()</p><p>End Sub</p><p>4.3.1.1.6 MouseUp</p><p>MouseUp(Button, ShiftState, MouseX, MouseY)</p><p>Ocorre quando se solta qualquer botão do mouse previamente clicado. Utilize este evento para especificar ações que</p><p>são disparadas somente quando o botão do mouse é solto.</p><p>https://msdn.microsoft.com/en-us/library/system.windows.forms.keys(VS.71).aspx</p><p>https://msdn.microsoft.com/en-us/library/system.windows.forms.keys(VS.71).aspx</p><p>91</p><p>Visualização</p><p>Parâmetros do evento MouseUp</p><p>NOME DESCRIÇÃO</p><p>Button Mostra o botão do mouse pressionado. Os valores</p><p>possíveis para este parâmetro são 1: O botão do mouse</p><p>pressionado é o esquerdo, 2: O botão do mouse</p><p>pressionado é o direito ou 4: O botão do mouse</p><p>pressionado é o do meio</p><p>ShiftState Mostra a tecla pressionada juntamente com o botão do</p><p>mouse. Os valores possíveis para este parâmetro são 4:</p><p>Tecla SHIFT, 8: Tecla CTRL ou 12: Teclas CTRL + SHIFT</p><p>MouseX Mostra a coordenada X onde o ponteiro do mouse foi</p><p>clicado na Tela</p><p>MouseY Mostra a coordenada Y onde o ponteiro do mouse foi</p><p>clicado na Tela</p><p>O script a seguir contém um exemplo de uso deste evento.</p><p>Sub TelaInicial_MouseUp(Button, ShiftState, MouseX, MouseY)</p><p>' Encerra a aplicação apenas quando o usuário soltar o botão.</p><p>Application.Exit()</p><p>End Sub</p><p>4.3.1.1.7 OnHide</p><p>OnHide()</p><p>Ocorre quando uma Tela está prestes a ser fechada. Utilize este evento quando for necessário efetuar alguma</p><p>operação antes do objeto Tela ser fechado. Este evento pode ocorrer de diversas maneiras:</p><p>· Quando a Tela é substituída por outra através dos métodos OpenScreen ou ShowScreen</p><p>· Quando o usuário fechar a janela onde está a Tela</p><p>· Quando for utilizado o método Close do objeto Tela</p><p>· Quando o Elipse E3 Viewer é fechado ou encerrado</p><p>4.3.1.1.8 OnPreShow</p><p>OnPreShow(Arg)</p><p>Ocorre antes da Tela ser mostrada. O parâmetro Arg recebe o conteúdo do parâmetro Arg dos métodos OpenScreen</p><p>e ShowScreen, que geram este evento. Logo após, é gerado o evento OnShow. O script a seguir contém um exemplo</p><p>de uso deste evento.</p><p>Sub Screen1_OnPreShow(Arg)</p><p>' O título da Tela Screen1 a ser mostrada</p><p>' foi passado como parâmetro na chamada do método</p><p>' OpenScreen que gerou o evento.</p><p>Caption = Arg</p><p>End Sub</p><p>4.3.1.1.9 OnShow</p><p>OnShow()</p><p>Ocorre no momento exato que uma Tela é mostrada. Utilize o evento OnPreShow para efetuar alguma operação</p><p>antes que a Tela seja exibida. O script a seguir contém um exemplo de uso deste evento.</p><p>Sub TelaPrincipal_OnShow()</p><p>MsgBox "Seja bem-vindo ao sistema!"</p><p>End Sub</p><p>4.3.1.2 Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Tela (Screen).</p><p>Visualização</p><p>92</p><p>4.3.1.2.1 Close</p><p>Close(Code)</p><p>Utilize este método para fechar a Tela. Este método gera o evento OnHide antes de ser efetivamente executado. O</p><p>parâmetro Code tem o valor de retorno para o método DoModal, se a Tela em questão é chamada por este método.</p><p>O script a seguir contém um exemplo de uso deste método.</p><p>Sub BotaoFecha_Click()</p><p>' Ao clicar em BotaoFecha, fecha a janela</p><p>Screen.Close(0)</p><p>End Sub</p><p>4.3.1.2.2 FromPixelX</p><p>FromPixelX(XPixel)</p><p>Converte a coordenada X da Tela, indicada pelo parâmetro XPixel, de pixels para Himetric. Este método é</p><p>complementar ao método ToPixelX.</p><p>4.3.1.2.3 FromPixelY</p><p>FromPixelY(YPixel)</p><p>Converte a coordenada Y da Tela, indicada pelo parâmetro YPixel, de pixels para Himetric. Este método é</p><p>complementar ao método ToPixelY.</p><p>4.3.1.2.4 ToPixelX</p><p>ToPixelX(XHimetric)</p><p>Converte a coordenada X da Tela, indicada pelo parâmetro XHimetric, de Himetric para pixels. Este método é</p><p>complementar ao método FromPixelX.</p><p>4.3.1.2.5 ToPixelY</p><p>ToPixelY(YHimetric)</p><p>Converte a coordenada Y da Tela, indicada pelo parâmetro YHimetric, de Himetric para pixels. Este método é</p><p>complementar ao método FromPixelY.</p><p>4.3.1.3 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Tela (Screen).</p><p>NOTA</p><p>O Elipse E3 utiliza para definição de coordenadas e espessura o sistema Himetric. Neste sistema, cada unidade</p><p>lógica equivale a um milésimo de centímetro; ou seja, cada 1000 unidades equivalem a 1 centímetro. Assim, este é o</p><p>padrão adotado na descrição das propriedades do Elipse E3, quando aplicável.</p><p>4.3.1.3.1 AllowContextMenu</p><p>Se configurada em Verdadeiro, esta propriedade habilita a exibição do menu contextual de uma Tela através do</p><p>botão direito do mouse em tempo de execução, exceto quando algum script está configurado com informação</p><p>divergente nos eventos MouseDown ou MouseUp. Caso contrário, o menu contextual não é mostrado. O valor</p><p>padrão desta propriedade é Verdadeiro.</p><p>4.3.1.3.2 AllowZoomChange</p><p>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</p><p>Tela. O valor padrão desta propriedade é Verdadeiro.</p><p>4.3.1.3.3 BackgroundColor</p><p>Especifica a cor de preenchimento do fundo da Tela. Nos scripts, utilize o método RGB do VBScript para montar a</p><p>cor a ser associada a esta propriedade. O valor padrão desta propriedade é cinza (RGB(192, 192, 192)).</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>93</p><p>Visualização</p><p>4.3.1.3.4 Caption</p><p>Esta propriedade define o título da Tela a ser mostrado na barra de título do Elipse E3 Viewer.</p><p>4.3.1.3.5 FillStyle</p><p>Esta propriedade especifica o estilo do preenchimento da Tela. A tabela a seguir contém os valores válidos para</p><p>esta propriedade.</p><p>Opções disponíveis para a propriedade FillStyle</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - Solid O preenchimento é sólido (padrão)</p><p>2 - Horizontal O preenchimento é com listras horizontais</p><p>3 - Vertical O preenchimento é com listras verticais</p><p>4 - Downward O preenchimento é com listras descendo da esquerda</p><p>para a direita em ângulo de 45 graus</p><p>5 - Upward O preenchimento é com listras subindo da esquerda</p><p>para a direita em ângulo de 45 graus</p><p>6 - Cross O preenchimento é com listras horizontais e verticais</p><p>7 - DiagonalCross O preenchimento é com listras descendo e subindo da</p><p>esquerda para a direita em ângulo de 45 graus</p><p>8 - Gradient O preenchimento é em degradê utilizando tanto</p><p>ForegroundColor quanto BackgroundColor. O efeito é</p><p>definido pela propriedade GradientStyle</p><p>11 - Background Preenche a Tela com a cor definida na propriedade</p><p>BackgroundColor</p><p>12 - Picture Preenche a Tela com a figura selecionada na</p><p>propriedade PictureFile</p><p>4.3.1.3.6 ForegroundColor</p><p>Especifica a cor do preenchimento da frente da Tela. Nos scripts, utilize o método RGB do VBScript para montar a</p><p>cor a ser associada a esta propriedade. O valor padrão desta propriedade é preto (RGB(0, 0, 0)). Aplicações</p><p>anteriores à introdução desta propriedade têm esta propriedade e a propriedade BackgroundColor configuradas</p><p>com a cor antes armazenada na propriedade BackgroundColor, e o estilo de preenchimento é configurado com o</p><p>valor 11 - Background, que pinta toda a Tela com a cor de fundo, ou seja, o comportamento antigo, anterior à</p><p>criação dos estilos. O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub Tela1_Click()</p><p>' Troca a cor de fundo da Tela para azul</p><p>ForegroundColor = RGB(0, 0, 255)</p><p>End Sub</p><p>4.3.1.3.7 GradientStyle</p><p>Esta propriedade especifica o estilo de preenchimento degradê de uma Tela. Esta propriedade só é utilizada</p><p>quando o valor da propriedade FillStyle está configurado para 8 (oito, Gradient). Os degradês consideram a</p><p>mudança partindo da cor configurada na propriedade ForegroundColor e indo para a cor configurada na</p><p>propriedade BackgroundColor.</p><p>Opções disponíveis</p><p>para a propriedade GradientStyle</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - LeftToRight Degradê vertical da esquerda para a direita (padrão)</p><p>1 - RightToLeft Degradê vertical da direita para a esquerda</p><p>2 - VertToCenter Degradê vertical das bordas para o centro</p><p>3 - VertFromCenter Degradê vertical do centro para as bordas</p><p>4 - TopDown Degradê horizontal de cima para baixo</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>Visualização</p><p>94</p><p>OPÇÃO DESCRIÇÃO</p><p>5 - BottomUp Degradê horizontal de baixo para cima</p><p>6 - HorzToCenter Degradê das bordas para o centro</p><p>7 - HorzFromCenter Degradê do centro para as bordas</p><p>8 - DiagDownRight Degradê diagonal para baixo com cor de frente na</p><p>direita</p><p>9 - DiagUpLeft Degradê diagonal para cima com a cor de frente na</p><p>esquerda</p><p>10 - DiagUpToCenter Degradê diagonal para cima das bordas para o centro</p><p>11 - DiagUpFromCenter Degradê diagonal para cima do centro para as bordas</p><p>12 - DiagDownLeft Degradê diagonal para baixo com cor de frente na</p><p>esquerda</p><p>13 - DiagUpRight Degradê diagonal para cima com a cor de frente na</p><p>direita</p><p>14 - DiagDownToCenter Degradê diagonal para baixo das bordas para o centro</p><p>15 - DiagDownFromCenter Degradê diagonal para baixo do centro para as bordas</p><p>16 - SpotBottomRight Degradê com cor de frente partindo do canto inferior</p><p>direito</p><p>17 - SpotBottomLeft Degradê com cor de frente partindo do canto inferior</p><p>esquerdo</p><p>18 - SpotTopLeft Degradê com cor de frente partindo do canto superior</p><p>esquerdo</p><p>19 - SpotTopRight Degradê com cor de frente partindo do canto superior</p><p>direito</p><p>20 - SpotFromCenter Degradê com cor de fundo do centro para as bordas</p><p>21 - SpotToCenter Degradê com cor de fundo das bordas para o centro</p><p>4.3.1.3.8 Layer</p><p>Esta propriedade define, para a Tela, quais camadas estão visíveis. Para os objetos de Tela, esta propriedade define</p><p>se aquele objeto de Tela está visível naquela camada. O valor desta propriedade representa uma máscara de 32 bits,</p><p>um bit para cada camada. Portanto, podem ser definidas até 32 camadas individuais. Assim, objetos podem ser</p><p>agrupados logicamente e mostrados ou escondidos apenas com a modificação da máscara desta propriedade.</p><p>95</p><p>Visualização</p><p>Opções da propriedade Layer</p><p>NOTA</p><p>A visibilidade de um objeto de Tela depende dos seguintes fatores: A propriedade Visible tem de estar configurada</p><p>para Verdadeiro, o objeto pai tem de estar visível e esta propriedade tem de estar habilitada para a Tela.</p><p>4.3.1.3.9 PictureFile</p><p>Contém o nome do arquivo da figura que é utilizada como fundo da Tela. Pode ser qualquer formato já suportado</p><p>no Elipse E3 pelo objeto DrawPicture (*.bmp, *.gif, *.jpg, *.cur, *.ico, *.emf, *.wmf, *.png e *.tif). O valor padrão desta</p><p>propriedade é uma String em branco. Esta propriedade só é válida se a propriedade FillStyle está selecionada com</p><p>o valor 12 - Picture.</p><p>4.3.1.3.10 PicturePosition</p><p>Indica a posição da figura selecionada na propriedade PictureFile na Tela. Esta propriedade só é válida se a</p><p>propriedade FillStyle está selecionada com o valor 12 - Picture. As opções válidas estão descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade PicturePosition</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - Center Figura no tamanho original, centralizada na Tela (padrão)</p><p>1 - Tile Figura no tamanho original, repetida tantas vezes</p><p>quantas forem necessárias para preencher a Tela</p><p>2 - Stretch Figura redimensionada para preencher a Tela</p><p>3 - TopLeft Figura no tamanho original, no canto esquerdo superior</p><p>da Tela</p><p>4 - BottomLeft Figura no tamanho original, no canto esquerdo inferior</p><p>da Tela</p><p>5 - BottomRight Figura no tamanho original, no canto direito inferior da</p><p>Tela</p><p>6 - TopRight Figura no tamanho original, no canto direito superior da</p><p>Tela</p><p>Visualização</p><p>96</p><p>4.3.1.3.11 RenderQuality</p><p>Controla a qualidade do desenho de uma Tela. Os valores possíveis para esta propriedade são os seguintes:</p><p>· 0 - rqDefault: A qualidade do desenho da Tela utiliza o valor definido na propriedade RenderQuality do Viewer.</p><p>Este é o valor padrão desta propriedade, mesmo em aplicações criadas em versões anteriores à 4.0</p><p>· 1 - rqNormal: Força o modo de qualidade normal (GDI, Graphics Device Interface) para o desenho da Tela</p><p>· 2 - rqHighQuality: Força o modo de alta qualidade (GDI+) para o desenho da Tela</p><p>A figura a seguir mostra o menu contextual de uma Tela em tempo de execução, com as respectivas opções de</p><p>configuração desta propriedade.</p><p>Opções da propriedade RenderQuality da Tela</p><p>4.3.1.3.12 ScreenAlignment</p><p>Controla o alinhamento da Tela em relação à area visível. Os valores possíveis para esta propriedade são os</p><p>seguintes:</p><p>· 0 - paDefault: Ajusta a Tela a seguir o valor definido pela propriedade ScreenAlignment do Viewer.</p><p>Corresponde à opção Utilizar Padrão do menu contextual Alinhamento (Esta Tela) da Tela, em tempo de</p><p>execução</p><p>· 1 - paTopLeft: Ajusta a Tela ao canto superior esquerdo em relação à área visível. Corresponde à opção Forçar</p><p>Superior Esquerdo do menu contextual Alinhamento (Esta Tela) da Tela, em tempo de execução</p><p>97</p><p>Visualização</p><p>· 2 - paCenter: Ajusta a Tela ao centro em relação à área visível. Corresponde à opção Forçar Centralizado do</p><p>menu contextual Alinhamento (Esta Tela) da Tela, em tempo de execução</p><p>A figura a seguir mostra o menu contextual de uma Tela em tempo de execução, com as respectivas opções de</p><p>configuração desta propriedade.</p><p>Opções da propriedade ScreenAlignment da Tela</p><p>4.3.2 Objetos de Tela</p><p>Esta seção contém informações sobre eventos, métodos e propriedades dos Objetos de Tela.</p><p>4.3.2.1 Eventos Comuns</p><p>Esta seção contém informações sobre os eventos comuns a todos os Objetos de Tela.</p><p>4.3.2.1.1 Click</p><p>Click()</p><p>Ocorre quando o botão esquerdo do mouse é pressionado sobre um objeto. Este evento não ocorre se o objeto não</p><p>está visível ou se a propriedade Enabled está configurada para Falso. A visibilidade de um objeto depende de três</p><p>fatores: propriedade Visible igual a Verdadeiro, objeto pai visível e propriedade Layer do objeto presente na camada</p><p>da Tela.</p><p>Visualização</p><p>98</p><p>4.3.2.1.2 DblClick</p><p>DblClick()</p><p>Ocorre quando há um duplo-clique, ou seja, o botão esquerdo do mouse é pressionado rapidamente duas vezes</p><p>sobre um objeto. Este evento não ocorre se o objeto não está visível ou se a propriedade Enabled está configurada</p><p>para Falso. A visibilidade do objeto depende de três fatores: propriedade Visible igual a Verdadeiro, objeto pai</p><p>visível e propriedade Layer do objeto presente na camada da Tela.</p><p>4.3.2.1.3 KeyDown</p><p>KeyDown(KeyCode, Shift)</p><p>Ocorre no momento em que uma tecla é pressionada e o objeto está com o foco do teclado. Note que este evento</p><p>não é gerado se o objeto não está habilitado, ou seja, a propriedade Enabled igual a Falso, ou este objeto não</p><p>possui o foco do teclado.</p><p>Parâmetros do evento KeyDown</p><p>NOME DESCRIÇÃO</p><p>KeyCode Número inteiro que identifica o caractere ASCII da tecla</p><p>pressionada</p><p>Shift Mostra o atalho de teclado usado juntamente com a</p><p>tecla pressionada. Os valores possíveis são 4: Tecla</p><p>SHIFT, 8: Tecla CTRL ou 12: Teclas CTRL + SHIFT</p><p>NOTA</p><p>Para uma lista com todos os códigos de tecla disponíveis para o parâmetro KeyCode, consulte o artigo Keys</p><p>Enumeration no Microsoft Developer Network.</p><p>4.3.2.1.4 KeyUp</p><p>KeyUp(KeyCode, Shift)</p><p>Ocorre no momento em que uma</p><p>do Viewer.</p><p>Caixa de diálogo Estilo da janela</p><p>1.3.2 Abrir Tela Modal</p><p>Abre uma Tela Modal, isto é, uma Tela que não permite a interação do usuário com outras Telas enquanto esta estiver</p><p>ativa.</p><p>7</p><p>Introdução</p><p>Configurações do Pick Abrir Tela Modal</p><p>Opções disponíveis no Pick Abrir Tela Modal</p><p>OPÇÃO DESCRIÇÃO</p><p>Abrir a tela Seleciona a Tela a ser aberta</p><p>Título Define o título da janela. Este texto é concatenado com o</p><p>nome da Tela</p><p>Zoom inicial Define o zoom da Tela, quando mostrada</p><p>Alinhamento da Tela Define o alinhamento da Tela em relação à área visível.</p><p>Os valores possíveis são Utilizar padrão, Forçar</p><p>Esquerdo Superior ou Forçar Centralizado</p><p>Parâmetro Indica um parâmetro a ser passado na chamada da Tela</p><p>Habilitar rolagem da Tela Habilita o uso das barras de rolagem na Tela</p><p>Especificar a posição da janela Determina a posição, em pixels, do quadro na janela, a</p><p>partir do canto superior esquerdo da Tela</p><p>Especificar o tamanho da janela Determina a largura e a altura, em pixels ou em Himetric,</p><p>da janela</p><p>Estilo da janela Abre a caixa de diálogo Estilo de Janela</p><p>Introdução</p><p>8</p><p>1.3.3 Executar Aplicação</p><p>Executa uma aplicação específica.</p><p>Configurações do Pick Executar Aplicação</p><p>Opções disponíveis no Pick Executar Aplicação</p><p>OPÇÃO DESCRIÇÃO</p><p>Aplicação Clicando-se em pode-se navegar no disco para indicar</p><p>o arquivo da aplicação a ser executada</p><p>Argumentos Permite especificar argumentos para a chamada da</p><p>aplicação</p><p>Executar no diretório Determina o diretório de trabalho da aplicação que é</p><p>executada</p><p>Modo de exibição Determina o tipo de janela de execução da aplicação. Os</p><p>valores possíveis são Normal, Maximizado ou</p><p>Minimizado</p><p>9</p><p>Introdução</p><p>1.3.4 Carregar Valor</p><p>Carrega um valor em um Tag.</p><p>Configurações do Pick Carregar Valor</p><p>Opções disponíveis no Pick Carregar Valor</p><p>OPÇÃO DESCRIÇÃO</p><p>Nome do tag Especifica o nome do Tag no qual é carregado o valor.</p><p>Pode-se selecionar o Tag no AppBrowser clicando em</p><p>Valor Determina o valor que é carregado no Tag. Pode-se</p><p>selecionar o tipo de dados clicando na caixa de seleção</p><p>1.3.5 Inverter Valor</p><p>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</p><p>é igual a Valor2, então o Tag recebe Valor1. Se o valor do Tag não é igual a Valor1 nem Valor2, o Tag recebe</p><p>Valor1.</p><p>É possível colocar tantos Picks Inverter Valor quantos se desejar. Isto permite a verificação de múltiplos valores para</p><p>um mesmo Tag ou até mesmo para diversos Tags em um mesmo evento.</p><p>Configurações do Pick Inverter Valor</p><p>Introdução</p><p>10</p><p>Opções disponíveis no Pick Inverter Valor</p><p>OPÇÃO DESCRIÇÃO</p><p>Nome do tag Clique em para abrir o AppBrowser e selecionar um</p><p>Tag</p><p>Valor 1 Determina o primeiro valor a comparar. Se o valor do Tag</p><p>é igual a Valor1, então o Tag recebe Valor2</p><p>Valor 2 Determina o segundo valor a comparar. Se o valor do Tag</p><p>é igual a Valor2, então o Tag recebe Valor1</p><p>1.3.6 Imprimir Relatório</p><p>Permite imprimir um Relatório de Seção em uma impressora ou mostrar em uma Tela.</p><p>Configurações do Pick Imprimir Relatório</p><p>Opções disponíveis no Pick Imprimir Relatório</p><p>OPÇÃO DESCRIÇÃO</p><p>Imprimir relatório Permite selecionar um Relatório de Seção para</p><p>impressão</p><p>Saída Determina o tipo de saída do Relatório de Seção. Os</p><p>valores possíveis são Impressora: Envia o Relatório de</p><p>Seção para a impressora, que corresponde ao método</p><p>Print, ou Tela: Executa uma prévia de impressão do</p><p>Relatório de Seção na tela, que corresponde ao método</p><p>PrintPreview</p><p>Especificar a posição da janela Determina a posição da prévia de impressão, em pixels,</p><p>a partir do canto superior esquerdo da janela. Se estes</p><p>valores não são definidos, a prévia de impressão é</p><p>mostrada na posição (0, 0)</p><p>11</p><p>Introdução</p><p>OPÇÃO DESCRIÇÃO</p><p>Especificar o tamanho da janela Especifica o tamanho da prévia de impressão na janela,</p><p>em pixels ou em Himetric. Se estes valores não são</p><p>definidos, a prévia de impressão é criada com o</p><p>tamanho de 500 por 500 pixels e a janela é aberta</p><p>maximizada. Se apenas uma das dimensões é definida,</p><p>largura ou altura, a outra dimensão é configurada para</p><p>500 pixels e a janela não é aberta maximizada</p><p>1.4 Eventos Definidos pelo Usuário</p><p>Apesar do Elipse E3 vir com uma extensa gama de eventos, muitas vezes o usuário pode querer criar um evento</p><p>específico para uma aplicação.</p><p>Um exemplo para a utilização de eventos definidos pelo usuário seria a realização de um cálculo ou tarefa mais</p><p>complexa em um objeto quando o evento gerador vem de um outro Tag ou propriedade.</p><p>Apesar de se poder criar e executar este mesmo tipo de tarefa a partir do próprio Tag ou da propriedade geradora</p><p>do evento, existem vantagens em manter-se um script junto ao objeto que sofre a ação. Dentre elas, pode-se citar o</p><p>trabalho adicional necessário para que um objeto aponte para outro, além de facilidades de manutenção, pois se por</p><p>algum motivo é necessário modificar ou apagar o Tag ou a propriedade que seja o evento gerador, não é necessário</p><p>modificar um segundo objeto.</p><p>Outra vantagem é o fato de que se o Tag gerador do evento é apagado, o objeto não perde o script, só é necessário</p><p>indicar uma outra fonte geradora daquele evento.</p><p>A geração de eventos internos facilita ainda a criação de bibliotecas, pois cada vez que um componente de biblioteca</p><p>é inserido em uma aplicação, traz consigo os scripts e cálculos que podem ser necessários, diminuindo o trabalho de</p><p>configuração. Para gerar um novo evento interno em um objeto, siga estes procedimentos:</p><p>1. Clique em Criar novo evento na lista de eventos da aba Scripts para abrir a janela Novo Evento de Usuário,</p><p>mostrada na figura a seguir.</p><p>Janela Novo Evento de Usuário</p><p>2. Digite um nome para o evento e clique em OK para abrir o Editor do evento de usuário, conforme as figuras a</p><p>seguir, que descrevem as opções possíveis para a condição de ocorrência deste evento.</p><p>Opção Sempre que a expressão alterar seu valor</p><p>Introdução</p><p>12</p><p>Opção Sempre que a expressão for verdadeira</p><p>3. As opções disponíveis neste Editor estão descritas na tabela a seguir.</p><p>Opções disponíveis no Editor de eventos de usuário</p><p>OPÇÃO DESCRIÇÃO</p><p>Nome Nome que identifica este evento. Esta opção não é</p><p>editável, portanto clique em Renomear Evento de</p><p>Usuário para modificar o nome do evento</p><p>Renomear Evento de Usuário Abre uma janela para modificar o nome do evento</p><p>Expressão Expressão geradora deste evento. Clique em para</p><p>abrir o AppBrowser para selecionar um Tag ou</p><p>propriedade, por exemplo</p><p>Remover Evento de Usuário Remove este evento da Lista de Eventos. NOTA: Ao</p><p>remover um evento de usuário, todos os scripts</p><p>associados a este evento são perdidos</p><p>Condição da Ocorrência Especifica qual a condição para que este evento ocorra.</p><p>As opções possíveis são Sempre que a expressão for</p><p>verdadeira ou Sempre que a expressão alterar seu</p><p>valor. No primeiro caso o evento é do tipo etOnEvent (o</p><p>evento ocorre no momento em que a expressão é</p><p>verdadeira) ou do tipo etWhileEvent (o evento ocorre</p><p>ciclicamente, em intervalos pré-definidos). No segundo</p><p>caso o evento é do tipo etOnValueChanged (o evento</p><p>ocorre sempre que a expressão muda o valor)</p><p>tecla é solta e o objeto está com o foco do teclado. Note que este evento não é</p><p>gerado se o objeto não está habilitado, ou seja, propriedade Enabled igual a Falso, ou se este objeto não possui o</p><p>foco do teclado.</p><p>Parâmetros do evento KeyUp</p><p>NOME DESCRIÇÃO</p><p>KeyCode Número inteiro que identifica o caractere ASCII da tecla</p><p>pressionada</p><p>Shift Mostra o atalho de teclado usado juntamente com a</p><p>tecla pressionada. Os valores possíveis são 4: Tecla</p><p>SHIFT, 8: Tecla CTRL ou 12: Teclas CTRL + SHIFT</p><p>NOTA</p><p>Para uma lista com todos os códigos de tecla disponíveis para o parâmetro KeyCode, consulte o artigo Keys</p><p>Enumeration no Microsoft Developer Network.</p><p>4.3.2.1.5 MouseDown</p><p>MouseDown(Button, ShiftState, MouseX, MouseY)</p><p>Ocorre quando se pressiona qualquer botão do mouse sobre um objeto.</p><p>Parâmetros do evento MouseDown</p><p>NOME DESCRIÇÃO</p><p>Button Mostra o botão do mouse pressionado. Os valores</p><p>possíveis são 1: O botão do mouse pressionado é o</p><p>esquerdo, 2: O botão do mouse pressionado é o direito</p><p>ou 4: O botão do mouse pressionado é o do meio</p><p>https://msdn.microsoft.com/en-us/library/system.windows.forms.keys(VS.71).aspx</p><p>https://msdn.microsoft.com/en-us/library/system.windows.forms.keys(VS.71).aspx</p><p>https://msdn.microsoft.com/en-us/library/system.windows.forms.keys(VS.71).aspx</p><p>https://msdn.microsoft.com/en-us/library/system.windows.forms.keys(VS.71).aspx</p><p>99</p><p>Visualização</p><p>NOME DESCRIÇÃO</p><p>ShiftState Mostra a tecla pressionada juntamente com o botão do</p><p>mouse. Os valores possíveis são 4: Tecla SHIFT, 8: Tecla</p><p>CTRL ou 12: Teclas CTRL + SHIFT</p><p>MouseX Mostra a coordenada horizontal onde o botão do mouse</p><p>foi clicado na Tela</p><p>MouseY Mostra a coordenada vertical onde o botão do mouse</p><p>foi clicado na Tela</p><p>4.3.2.1.6 MouseUp</p><p>MouseUp(Button, ShiftState, MouseX, MouseY)</p><p>Ocorre quando se solta qualquer botão do mouse previamente clicado sobre um objeto. Utilize este evento para</p><p>especificar ações que são disparadas somente quando o botão do mouse é solto.</p><p>Parâmetros do evento MouseUp</p><p>NOME DESCRIÇÃO</p><p>Button Mostra o botão do mouse pressionado. Os valores</p><p>possíveis são 1: O botão do mouse pressionado é o</p><p>esquerdo, 2: O botão do mouse pressionado é o direito</p><p>ou 4: O botão do mouse pressionado é o do meio</p><p>ShiftState Mostra a tecla pressionada juntamente com o botão do</p><p>mouse. Os valores possíveis são 4: Tecla SHIFT, 8: Tecla</p><p>CTRL ou 12: Teclas CTRL + SHIFT</p><p>MouseX Mostra a coordenada horizontal onde o botão do mouse</p><p>foi clicado na Tela</p><p>MouseY Mostra a coordenada vertical onde o botão do mouse</p><p>foi clicado na Tela</p><p>4.3.2.2 Métodos Comuns</p><p>Esta seção contém informações sobre os métodos comuns a todos os Objetos de Tela.</p><p>4.3.2.2.1 BringToFront</p><p>BringToFront()</p><p>Posiciona um objeto à frente de todos os outros objetos da Tela.</p><p>4.3.2.2.2 FitObject</p><p>FitObject([ScreenFillPercentage])</p><p>Este método enquadra um objeto no centro da Tela usando uma porcentagem relativa à Tela para preenchimento. O</p><p>parâmetro ScreenFillPercentage é opcional e, se não é informado, assume o valor 50, ou seja, o objeto ocupa 50% da</p><p>área da Tela. Os valores permitidos para este parâmetro variam entre 1 (um) e 100. Este método retorna erro nos</p><p>seguintes casos:</p><p>· O modo de alinhamento configurado na propriedade ScreenAlignment da Tela onde o objeto está inserido é</p><p>diferente de paCenter</p><p>· O objeto não está visível, ou seja, a propriedade Visible é igual a Falso</p><p>· As coordenadas X e Y do centro do objeto não estão contidas na área da Tela onde o objeto está inserido</p><p>4.3.2.2.3 SendToBack</p><p>SendToBack()</p><p>Posiciona um objeto atrás de todos os outros objetos da Tela.</p><p>Visualização</p><p>100</p><p>4.3.2.2.4 SetFocus</p><p>SetFocus()</p><p>Move o foco do ponteiro do mouse ou do teclado para um objeto determinado.</p><p>4.3.2.3 Propriedades Comuns</p><p>Esta seção contém informações sobre as propriedades comuns a todos os objetos de Tela. As propriedades</p><p>explicadas a seguir não se aplicam aos objetos MSForms, E3Chart, E3Browser e E3Alarm. Estes são descritos</p><p>posteriormente, em capítulos específicos para estes objetos.</p><p>NOTAS</p><p>· O Elipse E3 utiliza para definição de coordenadas e espessura o sistema Himetric. Neste sistema, cada unidade</p><p>lógica equivale a um milésimo de centímetro, ou seja, cada 1000 unidades equivalem a um centímetro. Assim, este</p><p>é o padrão adotado na descrição das propriedades do Elipse E3, quando aplicável.</p><p>· As propriedades listadas a seguir são comuns a todos os objetos citados anteriormente, inclusive o Grupo de</p><p>objetos e movimentos de Rotação e Translação.</p><p>4.3.2.3.1 Angle</p><p>Esta propriedade define o ângulo de rotação em graus, no sentido anti-horário, que um objeto deve ser</p><p>rotacionado. Isto também se aplica aos filhos que este objeto tenha, respeitando as limitações de rotação de cada</p><p>objeto filho. O objeto rotaciona de acordo com o centro, que pode ser editado durante a operação de rotação. O</p><p>valor padrão desta propriedade é 0 (zero, sem rotação).</p><p>4.3.2.3.2 BackgroundColor</p><p>Esta propriedade especifica a cor de preenchimento do fundo de um objeto. Esta cor é utilizada quando a</p><p>propriedade BackgroundStyle está configurada para 1 (um, opaco) e umas das propriedades VerticalPercentFill ou</p><p>HorizontalPercentFill está com valores diferentes de 100. Outro uso desta cor é quando a propriedade FillStyle está</p><p>configurada entre os valores 2 (dois) e 8 (oito). Isto permite que a área restante utilize a cor de fundo para</p><p>preenchimento. Nos scripts, utilize o método RGB do VBScript para montar a cor a ser associada a esta propriedade.</p><p>O valor padrão desta propriedade é cinza (RGB(192, 192, 192)).</p><p>4.3.2.3.3 BackgroundStyle</p><p>Esta propriedade especifica o modo do preenchimento do fundo de um objeto. Esta propriedade habilita a</p><p>utilização das propriedades VerticalPercentFill e HorizontalPercentFill com valores diferentes de 100 e também da</p><p>propriedade FillStyle configurada entre os valores 2 (dois) e 8 (oito). Isto permite que a área restante utilize a cor</p><p>configurada na propriedade BackgroundColor para preenchimento. A tabela a seguir contém os valores válidos para</p><p>esta propriedade.</p><p>Opções disponíveis para a propriedade BackgroundStyle</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - Transparent Nenhum fundo deste objeto é desenhado</p><p>1 - Opaque Caso visível, o fundo é desenhado (padrão)</p><p>4.3.2.3.4 BorderColor</p><p>Especifica a cor da borda ou a cor da linha de um objeto. Esta propriedade só é utilizada quando a propriedade</p><p>BorderStyle não está configurada para o valor 5 (cinco, Null), onde o objeto permanece sem borda. Nos scripts,</p><p>utilize o método RGB do VBScript para montar a cor a ser associada a esta propriedade. O valor padrão desta</p><p>propriedade é branco (RGB(255, 255, 255)), exceto para os objetos Display e SetPoint, cujo valor padrão desta</p><p>propriedade é cinza escuro (RGB(128,128,128)).</p><p>4.3.2.3.5 BorderStyle</p><p>Esta propriedade determina o estilo de borda que é aplicada a um objeto. As opções disponíveis para esta</p><p>propriedade estão descritas na tabela a seguir.</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>101</p><p>Visualização</p><p>Opções disponíveis para a propriedade BorderStyle</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - Normal Aplica uma borda sólida ao objeto (padrão)</p><p>1 - Dash Aplica uma borda com linha tracejada ao objeto</p><p>2 - Dot Aplica uma borda pontilhada ao objeto</p><p>3 - DashDot Aplica uma borda com traço-ponto ao objeto</p><p>4 - DashDotDot Aplica uma borda com traço-ponto-ponto ao objeto</p><p>5 - Null O objeto não tem uma borda</p><p>4.3.2.3.6 BorderWidth</p><p>Define a espessura, em unidades Himetric, da linha ou da</p><p>borda de um objeto. Só é utilizada se a propriedade</p><p>BorderStyle não está configurada para o valor 5 (Null). O valor padrão desta propriedade é 0 (zero). Esta é uma</p><p>exceção no sistema de medidas do Elipse E3, pois quando o valor é 0 (zero), a espessura da linha ou da borda não é</p><p>definida em unidades Himetric, mas sim em pixels. Configurar esta propriedade com o valor 0 (zero) indica a</p><p>espessura de um pixel.</p><p>4.3.2.3.7 Effect3D</p><p>Determina a aplicação de um efeito 3D no objeto selecionado. As opções disponíveis para esta propriedade estão</p><p>descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade Effect3D</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - No3D Transparente (padrão)</p><p>1 - Raised Aplica um efeito 3D em alto relevo</p><p>2 - Sunken Aplica um efeito 3D em baixo relevo</p><p>4.3.2.3.8 Effect3D_X</p><p>Especifica a dimensão do efeito 3D no eixo horizontal de um objeto (eixo X). O valor padrão desta propriedade é</p><p>30.</p><p>4.3.2.3.9 Effect3D_Y</p><p>Especifica a dimensão do efeito 3D no eixo vertical de um objeto (eixo Y). O valor padrão desta propriedade é 30.</p><p>4.3.2.3.10 Effect3DColorBase</p><p>Determina a cor da base do efeito 3D em um objeto. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).</p><p>4.3.2.3.11 Effect3DColorTop</p><p>Determina a cor do topo do efeito 3D em um objeto. O valor padrão desta propriedade é branco (RGB(255, 255,</p><p>255)).</p><p>4.3.2.3.12 Enabled</p><p>Habilita ou desabilita um objeto, isto é, o foco e a resposta aos eventos gerados pelo usuário. Se esta propriedade</p><p>está configurada para Verdadeiro, o objeto pode receber o foco, responder a eventos gerados pelo usuário e está</p><p>acessível através de scripts (padrão). Caso contrário, o usuário não pode interagir com o objeto usando o ponteiro</p><p>do mouse, pressionando teclas ou atalhos de teclado e o objeto aparece esmaecido. Além disto, se o objeto exibir</p><p>um bitmap, este bitmap permanece esmaecido sempre que este objeto está desabilitado.</p><p>Esta propriedade e a propriedade Locked, presente nos objetos Caixa de Seleção, Botão de Opção, Lista de</p><p>Seleção, Botão de Comando, Lista, Botão Liga-Desliga e Editor de Texto, são interligadas. Quando esta</p><p>propriedade e a propriedade Locked estão ambas configuradas em Verdadeiro, um objeto pode receber foco e</p><p>aparecer normalmente na Tela, e os dados podem ser copiados mas não editados. Quando esta propriedade é igual</p><p>a Verdadeiro, mas a propriedade Locked é igual a Falso, os dados podem ser não só copiados mas também</p><p>editados. No entanto, quando esta propriedade é igual a Falso, o objeto não recebe foco e permanece esmaecido na</p><p>Visualização</p><p>102</p><p>Tela, independente do status da propriedade Locked. Além disto, os dados não podem ser copiados nem tampouco</p><p>editados.</p><p>É possível combinar as configurações desta propriedade e da propriedade TabStop para impedir que o usuário</p><p>selecione um Botão de Comando com a tecla TAB, embora ainda seja permitido ao usuário clicar neste botão. Definir</p><p>a propriedade TabStop como Falso significa que o Botão de Comando não aparece na ordem de tabulação.</p><p>Entretanto, se esta propriedade é igual a Verdadeiro, o usuário ainda pode clicar no Botão de Comando, desde que a</p><p>propriedade TakeFocusOnClick esteja definida como Verdadeiro.</p><p>NOTA</p><p>Configurar esta propriedade no objeto Texto, Display e SetPoint para Falso em tempo de execução cancela a</p><p>edição corrente e descarta o conteúdo daquele objeto.</p><p>4.3.2.3.13 FillStyle</p><p>Esta propriedade especifica o estilo do preenchimento dos objetos de Tela. A tabela a seguir contém os valores</p><p>válidos para esta propriedade.</p><p>Opções disponíveis para a propriedade FillStyle</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - Solid O preenchimento é sólido (padrão)</p><p>1 - Hollow Não há preenchimento</p><p>2 - Horizontal O preenchimento é com listras horizontais</p><p>3 - Vertical O preenchimento é com listras verticais</p><p>4 - Downward O preenchimento é com listras descendo da esquerda</p><p>para a direita em ângulo de 45 graus</p><p>5 - Upward O preenchimento é com listras subindo da esquerda</p><p>para a direita em ângulo de 45 graus</p><p>6 - Cross O preenchimento é com listras horizontais e verticais</p><p>7 - DiagonalCross O preenchimento é com listras descendo e subindo da</p><p>esquerda para a direita em ângulo de 45 graus</p><p>8 - Gradient O preenchimento é em degradê utilizando tanto o valor</p><p>da propriedade ForegroundColor quanto o valor da</p><p>propriedade BackgroundColor. O efeito é definido pela</p><p>propriedade GradientStyle</p><p>9 - SemiTransparent Deixa o objeto de Tela translúcido</p><p>10 - MouseArea Não há preenchimento, mas o objeto de Tela continua</p><p>sensível aos eventos</p><p>11 - Background Preenche o objeto de Tela com a cor definida na</p><p>propriedade BackgroundColor</p><p>NOTA</p><p>Esta propriedade não está disponível para os objetos Figura, Animação com Translação e Animação com Rotação.</p><p>4.3.2.3.14 FlipHorizontal</p><p>Indica se um objeto de Tela está espelhado em relação ao eixo horizontal. O valor padrão desta propriedade é</p><p>Falso.</p><p>4.3.2.3.15 FlipVertical</p><p>Indica se um objeto de Tela está espelhado em relação ao eixo vertical. O valor padrão desta propriedade é Falso.</p><p>103</p><p>Visualização</p><p>4.3.2.3.16 ForegroundColor</p><p>Esta propriedade especifica a cor do preenchimento da frente de um objeto. Esta cor é utilizada quando a</p><p>propriedade FillStyle está configurada para 0 (zero, sólido) ou entre 2 (dois) e 9 (nove). Nos scripts, utilize o método</p><p>RGB do VBScript para montar a cor a ser associada a esta propriedade. O valor padrão desta propriedade é azul</p><p>(RGB(0, 0, 255)), exceto para os objetos Display e SetPoint, cujo valor padrão para esta propriedade é branco</p><p>(RGB(255, 255, 255)).</p><p>4.3.2.3.17 Frame</p><p>Retorna o Quadro pai de um objeto. Esta propriedade é somente de leitura.</p><p>4.3.2.3.18 GradientStyle</p><p>Esta propriedade especifica o estilo de preenchimento degradê de um objeto de Tela. Esta propriedade só é</p><p>utilizada quando o valor da propriedade FillStyle está configurado para 8 (oito, Gradient). Os degradês consideram</p><p>a mudança partindo da cor configurada na propriedade ForegroundColor e indo para a cor configurada na</p><p>propriedade BackgroundColor. Os valores possíveis para esta propriedade são os mesmos descritos na propriedade</p><p>GradientStyle da Tela.</p><p>IMPORTANTE</p><p>Um grande número de objetos mostrados com degradê, simultaneamente, acarretam uma perda de performance na</p><p>atualização da Tela. O uso de figuras no lugar pode resolver o problema.</p><p>NOTA</p><p>Esta propriedade não está disponível para os objetos Figura, Animação com Translação e Animação com Rotação.</p><p>4.3.2.3.19 HasFocus</p><p>Esta propriedade determina que o objeto selecionado tem o foco. Esta propriedade é somente de leitura.</p><p>4.3.2.3.20 Height</p><p>Determina a altura de um objeto.</p><p>4.3.2.3.21 HorizontalFillStyle</p><p>Define como é o preenchimento horizontal de um objeto. Esta propriedade trabalha em conjunto com a</p><p>propriedade HorizontalPercentFill, que informa qual porcentagem de um objeto deve ser preenchida. Estas duas</p><p>propriedades permitem uma simulação de um preenchimento de nível em um objeto, como ocorre em um nível de um</p><p>tanque, por exemplo.</p><p>Opções disponíveis para a propriedade HorizontalFillStyle</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - FillLeftToRight A porcentagem de preenchimento é da esquerda para a</p><p>direita (padrão)</p><p>1 - FillRightToLeft A porcentagem de preenchimento é da direita para a</p><p>esquerda</p><p>2 - FillCenterToEdgesH A porcentagem de preenchimento é do centro para as</p><p>bordas</p><p>4.3.2.3.22 HorizontalPercentFill</p><p>Utilize esta propriedade para especificar qual a porcentagem da área horizontal de um objeto deve ser preenchida.</p><p>Os valores aceitos por esta propriedade variam de 0 (zero) a 100. Esta propriedade trabalha em conjunto com a</p><p>propriedade HorizontalFillStyle, que informa como este preenchimento ocorre. O valor padrão desta propriedade é</p><p>100.</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>Visualização</p><p>104</p><p>4.3.2.3.23 MouseOver</p><p>Esta propriedade informa se o ponteiro do mouse encontra-se sobre a Tela. Caso afirmativo, esta propriedade é</p><p>habilitada. Do contrário, é desabilitada. Esta propriedade é somente de leitura. O valor padrão desta propriedade é</p><p>Falso.</p><p>4.3.2.3.24 MouseOverChild</p><p>Esta propriedade informa se o ponteiro do mouse encontra-se sobre um dos objetos inseridos na Tela. Caso</p><p>afirmativo, esta propriedade é habilitada. Do contrário, é desabilitada. Esta propriedade é somente de leitura. O valor</p><p>padrão desta propriedade é Falso.</p><p>4.3.2.3.25 Screen</p><p>Retorna a Tela pai de um objeto. Esta propriedade é somente de leitura.</p><p>4.3.2.3.26 Shadow</p><p>Indica a presença do efeito de sombra em um objeto. Se configurada para Verdadeiro, o objeto possui uma</p><p>sombra, cujas coordenadas são estabelecidas pelas propriedades ShadowX e ShadowY. Do contrário, o objeto não</p><p>possui o efeito de sombra. O valor padrão desta propriedade é Falso.</p><p>4.3.2.3.27 ShadowColor</p><p>Especifica a cor do preenchimento da sombra de um objeto. Esta cor é utilizada quando a propriedade Shadow</p><p>está configurada para Verdadeiro. Nos scripts, utilize o método RGB do VBScript para montar a cor a ser associada a</p><p>esta propriedade. O valor padrão desta propriedade é cinza escuro (RGB(128, 128, 128)).</p><p>4.3.2.3.28 ShadowX</p><p>Define a coordenada vertical à esquerda da sombra de um objeto, em unidades Himetric. Esta sombra é sempre</p><p>relativa à propriedade X do objeto. Valores positivos indicam que a sombra está à direita do objeto, e negativos à</p><p>esquerda. O valor padrão desta propriedade é 200.</p><p>4.3.2.3.29 ShadowY</p><p>Define a coordenada horizontal superior da sombra de um objeto, em unidades Himetric. Esta sombra é sempre</p><p>relativa à propriedade Y do objeto. Valores positivos indicam que a sombra está abaixo do objeto, e negativos acima.</p><p>O valor padrão desta propriedade é 200.</p><p>4.3.2.3.30 TabStop</p><p>Esta propriedade determina a utilização da tecla TAB na aplicação. Se esta propriedade está configurada em</p><p>Verdadeiro, é possível utilizar a tecla TAB. Caso contrário, esta tecla não pode ser utilizada.</p><p>4.3.2.3.31 Tip</p><p>Esta propriedade mostra um texto pop-up quando o ponteiro do mouse permanece por um breve momento sobre</p><p>o objeto em tempo de execução.</p><p>4.3.2.3.32 VerticalFillStyle</p><p>Define como é o preenchimento vertical de um objeto. Esta propriedade trabalha em conjunto com a propriedade</p><p>VerticalPercentFill, que informa qual porcentagem do objeto deve ser preenchida. Estas duas propriedades</p><p>permitem uma simulação de um preenchimento de nível em um objeto.</p><p>Opções disponíveis para a propriedade VerticalFillStyle</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - FillBottomToTop A porcentagem de preenchimento é de baixo para cima</p><p>(padrão)</p><p>1 - FillTopToBottom A porcentagem de preenchimento é de cima para baixo</p><p>2 - FillCenterToEdgesV A porcentagem de preenchimento é do centro para as</p><p>bordas</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>105</p><p>Visualização</p><p>4.3.2.3.33 VerticalPercentFill</p><p>Utilize esta propriedade para especificar qual a porcentagem da área vertical de um objeto deve ser preenchida. Os</p><p>valores aceitos por esta propriedade variam de 0 (zero) a 100. Esta propriedade trabalha em conjunto com a</p><p>propriedade VerticalFillStyle, que informa como este preenchimento ocorre. O valor padrão desta propriedade é</p><p>100.</p><p>4.3.2.3.34 Visible</p><p>Esta propriedade define a visibilidade de um objeto. Se esta propriedade está configurada como Verdadeiro, o</p><p>objeto permanece visível, desde que também sejam obedecidos os seguintes fatores: o objeto pai deste objeto</p><p>também deve estar visível e a propriedade Layer deste objeto também deve estar presente na camada da Tela.</p><p>4.3.2.3.35 Width</p><p>Determina a largura de um objeto, em unidades Himetric.</p><p>4.3.2.3.36 X</p><p>Esta propriedade define a coordenada horizontal esquerda, em unidades Himetric, de um objeto.</p><p>4.3.2.3.37 Y</p><p>Esta propriedade define a coordenada vertical superior, em unidades Himetric, de um objeto.</p><p>4.3.2.4 Animação com Rotação</p><p>Esta seção contém informações sobre propriedades do objeto Animação com Rotação (DynamicRotate). Este objeto</p><p>não possui eventos nem métodos associados.</p><p>4.3.2.4.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Animação com Rotação (DynamicRotate).</p><p>4.3.2.4.1.1 Detents</p><p>Esta propriedade determina o número de passos do movimento deste objeto.</p><p>4.3.2.4.1.2 EnableOverrideLineColor</p><p>Esta propriedade habilita ou desabilita este objeto a sobrescrever a cor original da linha da imagem pela cor</p><p>definida na propriedade OverrideLineColor. Se esta propriedade está habilitada, isto permite que seja modificada a</p><p>cor original da linha deste objeto pela cor da propriedade OverrideLineColor. Caso contrário, este objeto exibe a cor</p><p>original. O valor padrão desta propriedade é Falso.</p><p>4.3.2.4.1.3 EnableSlider</p><p>Esta propriedade habilita o slider no movimento deste objeto.</p><p>4.3.2.4.1.4 OverrideFillColor</p><p>Quando a propriedade OverrideFillMode é configurada com os valores 2 (dois) ou 3 (três), esta propriedade é</p><p>usada para definir a cor a ser usada no preenchimento dos objetos no movimento, ao invés da cor original. Nos</p><p>scripts, utilize o método RGB do VBScript para montar a cor a ser associada a esta propriedade. O valor padrão desta</p><p>propriedade é vermelho (RGB(255, 0, 0)).</p><p>4.3.2.4.1.5 OverrideFillMode</p><p>Esta propriedade especifica o modo do preenchimento dos objetos que estão em movimento e altera o modo</p><p>original de preenchimento da imagem, sem alterar a configuração original de preenchimento dos objetos. Os valores</p><p>possíveis para esta propriedade estão descritos na tabela a seguir.</p><p>Opções disponíveis para a propriedade OverrideFillMode</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - NoOverride Preenchimento original dos objetos (padrão)</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>Visualização</p><p>106</p><p>OPÇÃO DESCRIÇÃO</p><p>1 - Wireframe Os objetos não são preenchidos, desenham somente as</p><p>bordas</p><p>2 - SolidFill O preenchimento dos objetos contidos no grupo é</p><p>sólido com a cor especificada na propriedade</p><p>OverrideFillColor</p><p>3 - ByBrightness O preenchimento dos objetos contidos no grupo é</p><p>sólido com a cor especificada pela propriedade</p><p>OverrideFillColor, porém leva em conta qual era a</p><p>intensidade da cor original de preenchimento de cada</p><p>objeto</p><p>4.3.2.4.1.6 OverrideLineColor</p><p>Quando a propriedade EnableOverrideLineColor está configurada para Verdadeiro, esta propriedade é usada</p><p>para definir a cor a ser usada na cor da linha dos objetos em movimento, ao invés da cor original. Nos scripts, utilize</p><p>o método RGB do VBScript para montar a cor a ser associada a esta propriedade. O valor padrão desta propriedade</p><p>é vermelho (RGB(255, 0, 0)).</p><p>4.3.2.4.1.7 RangeMax</p><p>Esta propriedade determina o alcance máximo do movimento rotacional deste objeto.</p><p>4.3.2.4.1.8 RangeMin</p><p>Esta propriedade determina o alcance mínimo do movimento rotacional deste objeto.</p><p>4.3.2.4.1.9 RotationAngle</p><p>Esta propriedade determina o ângulo de rotação do movimento deste objeto.</p><p>4.3.2.4.1.10 RotationDirection</p><p>Esta propriedade determina a direção do ângulo de rotação do movimento deste objeto. Os valores possíveis</p><p>para esta propriedade estão descritos na tabela a seguir.</p><p>Opções disponíveis para a propriedade RotationDirection</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - Clockwise Direciona o ângulo de rotação à direita deste objeto</p><p>(padrão)</p><p>1 - Counterclockwise Direciona o ângulo de rotação à esquerda deste objeto</p><p>4.3.2.4.1.11 Value</p><p>Indica o valor inicial do movimento. Deve</p><p>ser um valor entre os valores definidos nas propriedades RangeMax e</p><p>RangeMin.</p><p>4.3.2.5 Animação com Translação</p><p>Esta seção contém informações sobre propriedades do objeto Animação com Translação (DynamicMove). Este objeto</p><p>não possui eventos nem métodos associados.</p><p>4.3.2.5.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Animar com Translação (DynamicMove).</p><p>4.3.2.5.1.1 Detents</p><p>Esta propriedade determina o número de passos do movimento deste objeto.</p><p>4.3.2.5.1.2 EnableOverrideLineColor</p><p>Esta propriedade habilita ou desabilita este objeto a sobrescrever a cor original da linha da imagem pela cor</p><p>definida na propriedade OverrideLineColor. Se esta propriedade está habilitada, isto permite que seja modificada a</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>107</p><p>Visualização</p><p>cor original da linha deste objeto pela cor definida na propriedade OverrideLineColor. Caso contrário, este objeto</p><p>exibe a cor original. O valor padrão desta propriedade é Falso.</p><p>4.3.2.5.1.3 EnableSlider</p><p>Esta propriedade habilita o slider no movimento deste objeto.</p><p>4.3.2.5.1.4 OverrideFillColor</p><p>Quando a propriedade OverrideFillMode é configurada com os valores 2 (dois) ou 3 (três), esta propriedade é</p><p>usada para definir a cor a ser usada no preenchimento dos objetos no movimento, ao invés da cor original. Nos</p><p>scripts, utilize o método RGB do VBScript para montar a cor a ser associada a esta propriedade. O valor padrão desta</p><p>propriedade é vermelho (RGB(255, 0, 0)).</p><p>4.3.2.5.1.5 OverrideFillMode</p><p>Esta propriedade especifica o modo do preenchimento dos objetos que estão em movimento e altera o modo</p><p>original de preenchimento da imagem, sem alterar a configuração original de preenchimento dos objetos. Os valores</p><p>possíveis para esta propriedade estão descritos na tabela a seguir.</p><p>Opções disponíveis para a propriedade OverrideFillMode</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - NoOverride Preenchimento original dos objetos (padrão)</p><p>1 - Wireframe Os objetos não são preenchidos, desenham somente as</p><p>bordas</p><p>2 - SolidFill O preenchimento dos objetos contidos no grupo é</p><p>sólido com a cor especificada na propriedade</p><p>OverrideFillColor</p><p>3 - ByBrightness O preenchimento dos objetos contidos no grupo é</p><p>sólido com a cor especificada pela propriedade</p><p>OverrideFillColor, porém leva em conta qual era a</p><p>intensidade da cor original de preenchimento de cada</p><p>objeto</p><p>4.3.2.5.1.6 OverrideLineColor</p><p>Quando a propriedade EnableOverrideLineColor está configurada para Verdadeiro, esta propriedade é usada</p><p>para definir a cor a ser usada na cor da linha dos objetos em movimento, ao invés da cor original. Nos scripts, utilize</p><p>o método RGB do VBScript para montar a cor a ser associada a esta propriedade. O valor padrão desta propriedade</p><p>é vermelho (RGB(255, 0, 0)).</p><p>4.3.2.5.1.7 RangeMax</p><p>Esta propriedade determina o alcance máximo do movimento linear deste objeto.</p><p>4.3.2.5.1.8 RangeMin</p><p>Esta propriedade determina o alcance mínimo do movimento linear deste objeto.</p><p>4.3.2.5.1.9 Value</p><p>Indica o valor inicial do movimento. Deve ser um valor entre os valores definidos nas propriedades RangeMax e</p><p>RangeMin.</p><p>4.3.2.6 Arco de Elipse</p><p>Esta seção contém informações sobre propriedades do objeto Arco de Elipse (DrawArc). Este objeto não possui</p><p>eventos nem métodos associados.</p><p>4.3.2.6.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Arco de Elipse (DrawArc).</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>Visualização</p><p>108</p><p>4.3.2.6.1.1 ArcBeginAngle</p><p>Esta propriedade configura o ângulo inicial do arco do objeto, em graus. O intervalo aceito por esta propriedade</p><p>vai de 0 (zero) até 359. O estilo e forma do arco dependem também das configurações das propriedades</p><p>ArcEndAngle e ArcStyle. O valor padrão desta propriedade é 0 (zero). O script a seguir contém um exemplo de uso</p><p>desta propriedade.</p><p>Sub CommandButton9_Click()</p><p>Screen.Item("Arco1").ArcBeginAngle = 12</p><p>End Sub</p><p>4.3.2.6.1.2 ArcEndAngle</p><p>Esta propriedade configura o ângulo final do arco do objeto, em graus. O intervalo aceito por esta propriedade vai</p><p>de 0 (zero) até 359. O estilo e forma do arco dependem também das configurações das propriedades ArcBeginAngle</p><p>e ArcStyle. O valor padrão desta propriedade é 270. O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub CommandButton9_Click()</p><p>Screen.Item("Arco1").ArcEndAngle = 12</p><p>End Sub</p><p>4.3.2.6.1.3 ArcStyle</p><p>Esta propriedade especifica o estilo da borda ou linha do objeto. A borda do objeto é desenhada conforme o</p><p>estilo definido, utilizando a cor especificada na propriedade BorderColor com a espessura especificada na</p><p>propriedade BorderWidth. A tabela a seguir contém os valores válidos para esta propriedade.</p><p>Opções disponíveis para a propriedade ArcStyle</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - arc O estilo do desenho é um arco</p><p>1 - chord O estilo do desenho é uma corda, unindo o ponto inicial</p><p>e final</p><p>2 - pie O estilo do desenho é uma pizza (padrão)</p><p>O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub CommandButton9_Click()</p><p>Screen.Item("Arco1").ArcStyle = 1</p><p>End Sub</p><p>4.3.2.7 Conector</p><p>Esta seção contém informações sobre propriedades do objeto Conector (DrawConnector). Este objeto não possui</p><p>eventos nem métodos associados.</p><p>4.3.2.7.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Conector (DrawConnector).</p><p>4.3.2.7.1.1 Points</p><p>Retorna o objeto Coleção de Pontos de Conexão dentro do Conector. O objeto Coleção de Pontos de Conexão é</p><p>utilizado para inserir, remover ou acessar os Pontos de Conexão disponíveis no Conector. Esta propriedade é</p><p>somente de leitura.</p><p>4.3.2.7.2 Coleção de Pontos de Conexão</p><p>Esta seção contém informações sobre métodos e propriedades do objeto Coleção de Pontos de Conexão</p><p>(DrawConnectorPoints). Este objeto não possui eventos associados.</p><p>4.3.2.7.2.1 Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Coleção de Pontos de Conexão (DrawConnectorPoints).</p><p>109</p><p>Visualização</p><p>AddPoint</p><p>AddPoint(X, Y, [IndexAt])</p><p>Adiciona um Ponto de Conexão na Coleção de Pontos de Conexão e retorna este objeto. O objeto é inserido nas</p><p>coordenadas especificadas pelos parâmetros X e Y e no índice especificado pelo parâmetro IndexAt. Se este</p><p>parâmetro é omitido ou é igual a -1 (menos um), o Ponto de Conexão é adicionado ao final da sequência de Pontos</p><p>de Conexão. Caso contrário, o valor deste parâmetro deve ser um número entre 1 (um) e o valor da propriedade</p><p>Count menos um.</p><p>DeletePoint</p><p>DeletePoint(NameIndex)</p><p>Remove o Ponto de Conexão indicado pelo parâmetro NameIndex, que pode ser tanto o índice quanto o nome deste</p><p>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</p><p>Pontos de Conexão com mais de dois Pontos de Conexão.</p><p>Item</p><p>Item(NameIndex)</p><p>Retorna um objeto Ponto de Conexão indicado pelo parâmetro NameIndex, que tanto pode ser o índice quanto o</p><p>nome deste Ponto de Conexão na Coleção de Pontos de Conexão.</p><p>4.3.2.7.2.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Coleção de Pontos de Conexão</p><p>(DrawConnectorPoints).</p><p>Count</p><p>Contém o número de Pontos de Conexão na Coleção. Esta propriedade é somente de leitura.</p><p>4.3.2.7.2.3 Ponto de Conexão</p><p>Esta seção contém informações sobre métodos e propriedades do objeto Ponto de Conexão (DrawConnectorPoint).</p><p>Este objeto não possui eventos associados.</p><p>Métodos</p><p>Esta seção contém</p><p>informações sobre os métodos do objeto Ponto de Conexão (DrawConnectorPoint).</p><p>ConnectTo</p><p>ConnectTo(Object, SlotNameIndex)</p><p>Conecta este Ponto de Conexão a um outro objeto de Tela, indicado no parâmetro Object, e desfaz a conexão</p><p>existente, se necessário. O parâmetro SlotNameIndex indica o índice ou o nome onde este Ponto de Conexão deve se</p><p>conectar na Coleção de Pontos de Conexão.</p><p>Delete</p><p>Delete()</p><p>Remove este Ponto de Conexão. Após utilizar este método, qualquer tentativa de acessar este objeto retorna um erro.</p><p>Disconnect</p><p>Disconnect([X], [Y])</p><p>Desconecta este Ponto de Conexão e retorna Verdadeiro se estava conectado ou Falso se não estava conectado. Os</p><p>parâmetros X e Y são opcionais e indicam as coordenadas horizontais e verticais deste Ponto de Conexão.</p><p>Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Ponto de Conexão (DrawConnectorPoint).</p><p>IsConnected</p><p>Indica se este Ponto de Conexão está conectado ou não a algum objeto de Tela. Caso esteja conectado, as</p><p>propriedades X e Y podem ser lidas mas não modificadas.</p><p>Name</p><p>Retorna o nome deste Ponto de Conexão. Esta propriedade é somente de leitura.</p><p>Visualização</p><p>110</p><p>NOTA</p><p>· O nome de um Ponto de Conexão pode mudar ao inserir ou remover Pontos de Conexão da Coleção de Pontos</p><p>de Conexão.</p><p>· O primeiro e o último Ponto de Conexão na Coleção de Pontos de Conexão são nomeados, respectivamente,</p><p>como "Begin" e "End". Todos os outros Pontos são nomeados como "PlugN", onde N é o índice do Ponto na</p><p>Coleção.</p><p>X</p><p>Indica a coordenada horizontal deste Ponto de Conexão em relação à borda esquerda da Tela, em unidades</p><p>Himetric.</p><p>Y</p><p>Indica a coordenada vertical deste Ponto de Conexão em relação à borda superior da Tela, em unidades Himetric.</p><p>4.3.2.8 E2Controls</p><p>Esta seção contém informações sobre eventos, métodos e propriedades de objetos E2Controls.</p><p>4.3.2.8.1 Propriedades Comuns</p><p>Esta seção contém informações sobre propriedades comuns aos objetos E2Controls.</p><p>4.3.2.8.1.1 Frame_BorderColor</p><p>Define uma cor para a moldura de um objeto.</p><p>4.3.2.8.1.2 Frame_BorderEnabled</p><p>Habilita ou desabilita a moldura de um objeto.</p><p>4.3.2.8.1.3 Frame_BorderThickness</p><p>Define a espessura da moldura de um objeto, em pixels.</p><p>4.3.2.8.1.4 Frame_Color</p><p>Define a cor de fundo da área de título de um objeto. O valor padrão desta propriedade é cinza (RGB(192, 192,</p><p>192)).</p><p>4.3.2.8.1.5 Frame_Enable</p><p>Habilita ou desabilita a exibição da moldura de um objeto. O valor padrão desta propriedade é, exceto para o</p><p>objeto E2Button.</p><p>4.3.2.8.1.6 Frame_Enable3D</p><p>Habilita ou desabilita o efeito 3D para a moldura de um objeto.</p><p>4.3.2.8.1.7 Frame_Separator</p><p>Habilita ou desabilita a exibição de uma linha separadora entre o título e o objeto.</p><p>4.3.2.8.1.8 Frame_Set3DInset</p><p>Se esta propriedade está ajustada para Verdadeiro, a borda de um objeto aparece rebaixada. Se está ajustada</p><p>para Falso, o valor padrão, a borda do objeto aparece ressaltada.</p><p>4.3.2.8.1.9 Frame_Thickness3D</p><p>Define a espessura da borda 3D da moldura de um objeto, em pixels.</p><p>4.3.2.8.1.10 Frame_Title</p><p>Esta propriedade define o título da moldura de um objeto.</p><p>111</p><p>Visualização</p><p>4.3.2.8.1.11 Frame_TitleColor</p><p>Define a cor da fonte do título da moldura de um objeto. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).</p><p>4.3.2.8.1.12 Frame_TitleEnabled</p><p>Habilita ou desabilita a exibição do título da moldura de um objeto. O valor padrão desta propriedade é</p><p>Verdadeiro.</p><p>4.3.2.8.1.13 Frame_TitleFont</p><p>Esta propriedade é utilizada para determinar a fonte do título da moldura de um objeto. Esta propriedade não</p><p>pode ser utilizada em scripts ou em Associações e é configurada unicamente via Elipse E3 Studio. Consulte o tópico</p><p>Fonte para mais informações sobre as subpropriedades desta propriedade.</p><p>4.3.2.8.2 E2Animation</p><p>Esta seção contém informações sobre propriedades do objeto E2Animation. Este objeto não possui eventos nem</p><p>métodos associados.</p><p>4.3.2.8.2.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto E2Animation.</p><p>BackgroundColor</p><p>Esta propriedade define a cor de fundo do objeto E2Animation. O valor padrão desta propriedade é branco</p><p>(RGB(255, 255, 255)).</p><p>BlinkTime</p><p>Define o intervalo de tempo, em milissegundos, do efeito de piscar do objeto.</p><p>Border</p><p>Habilita ou desabilita a exibição de uma borda ao redor do objeto.</p><p>DefaultZone</p><p>Define a zona padrão que é mostrada quando o Tag associado estiver fora dos limites das outras zonas definidas</p><p>para o objeto.</p><p>IsTransparent</p><p>Se o valor desta propriedade é Verdadeiro, define que o fundo do objeto é transparente, permitindo que o fundo</p><p>da Tela apareça. Caso contrário, a cor de fundo é sólida, definida em BackgroundColor.</p><p>Value</p><p>Essa propriedade define o valor que determina qual a Zona ativa. O valor padrão desta propriedade é 0 (zero).</p><p>Zones</p><p>Coleção de Zonas de um objeto E2Animation. Esta propriedade é somente de leitura.</p><p>4.3.2.8.2.2 Coleção de Zonas</p><p>Esta seção contém informações sobre métodos do objeto Coleção de Zonas (AnimationZoneCollection). Este objeto</p><p>não contém eventos nem propriedades associadas.</p><p>Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Coleção de Zonas (AnimationZoneCollection).</p><p>Add</p><p>Add([AxisName])</p><p>Adiciona uma nova Zona na Coleção de Zonas. O parâmetro AxisName é opcional e não tem efeito, sendo mantido</p><p>por questões de compatibilidade com versões anteriores.</p><p>Remove</p><p>Remove(Index)</p><p>Remove uma Zona. O parâmetro Index indica o índice da Zona que deve ser removida.</p><p>Visualização</p><p>112</p><p>Zonas</p><p>As Zonas definem um conjunto de imagens de bitmap que são usadas para criar o efeito de animação no objeto. As</p><p>Zonas (AnimationZone) podem ser configuradas acessando a janela Propriedades do objeto, na aba E2Animation. As</p><p>opções desta janela estão descritas na tabela a seguir.</p><p>Opções disponíveis na aba E2Animation</p><p>OPÇÃO DESCRIÇÃO</p><p>Zonas Listagem com todas as Zonas definidas no objeto</p><p>Adicionar Adiciona uma nova Zona</p><p>Remover Apaga a Zona selecionada</p><p>Zona Padrão Define a Zona selecionada como a Zona padrão do</p><p>objeto</p><p>Pisca Define se o bitmap pisca quando o valor do objeto</p><p>estiver dentro do intervalo da Zona</p><p>Dica Mostra um texto de ajuda sobre a Zona</p><p>Mínimo Valor mínimo para a variação da Zona</p><p>Máximo Valor máximo para a variação da Zona</p><p>Arquivo de imagem Nome do arquivo de bitmap que é mostrado quando o</p><p>valor do objeto estiver dentro do intervalo da Zona</p><p>Exemplo Mostra uma prévia do arquivo de bitmap da Zona</p><p>selecionada</p><p>Propriedades</p><p>Esta seção contém informações sobre as propriedades das Zonas do objeto E2Animation (AnimationZone).</p><p>Blink</p><p>Indica que esta Zona participa do efeito de piscar. O valor padrão desta propriedade é Falso.</p><p>Filename</p><p>Indica qual o nome do arquivo de imagem utilizado na Zona.</p><p>Maximum</p><p>Define o valor máximo para a Zona. O valor padrão desta propriedade é 20000.</p><p>Minimum</p><p>Define o valor mínimo para a Zona. O valor padrão desta propriedade é 0 (zero).</p><p>TipEnable</p><p>Habilita ou desabilita a dica para a Zona. O valor padrão desta propriedade é Falso.</p><p>TipText</p><p>Define o texto da dica para a Zona. O valor padrão desta propriedade é uma String em branco.</p><p>4.3.2.8.3 E2Bitmap</p><p>Esta seção contém informações sobre propriedades do objeto E2Bitmap. Este objeto não possui eventos nem</p><p>métodos associados.</p><p>4.3.2.8.3.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto E2Bitmap.</p><p>Filename</p><p>Define o nome do arquivo de imagem associado ao objeto E2Bitmap. O caminho do arquivo pode ser tanto o</p><p>caminho completo do arquivo no disco, quanto o caminho relativo à aplicação,</p><p>quando o arquivo de imagem é</p><p>inserido como um Recurso da aplicação. O valor padrão desta propriedade é vazio.</p><p>IsTransparent</p><p>Esta propriedade habilita ou desabilita a transparência do objeto, baseada na cor definida na propriedade</p><p>TransparentColor.</p><p>113</p><p>Visualização</p><p>TransparentColor</p><p>Define qual cor é considerada pela propriedade IsTransparent como sendo transparente. O valor padrão desta</p><p>propriedade é branco (RBG(255, 255, 255)).</p><p>4.3.2.8.4 E2Button</p><p>Esta seção contém informações sobre eventos e propriedades do objeto E2Button. Este objeto não possui métodos</p><p>associados.</p><p>4.3.2.8.4.1 Eventos</p><p>Esta seção contém informações sobre os eventos do objeto E2Button.</p><p>OnRelease</p><p>OnRelease()</p><p>Este evento é gerado quando o botão do mouse é solto.</p><p>4.3.2.8.4.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto E2Button.</p><p>Action</p><p>Esta propriedade define o comportamento do objeto E2Button quando é clicado. Os valores possíveis para esta</p><p>propriedade são 0 - MOMENTARY: Comportamento normal do botão, aparecendo rebaixado somente enquanto o</p><p>mouse está pressionado (padrão), 1 - TOGGLE: Possui dois estados, ligado e desligado ou 2 - JOG: Alterna entre dois</p><p>valores, um quando o botão é pressionado e outro quando o botão é solto.</p><p>Alignment</p><p>Determina o alinhamento do texto do botão. Os valores possíveis para esta propriedade são 0 -</p><p>HorizontalAlignmentLeft: Alinha o texto à esquerda, 1 - HorizontalAlignmentCenter: Alinha o texto ao centro</p><p>(padrão) ou 2 - HorizontalAlignmentRight: Alinha o texto à direita.</p><p>BackgroundColor0</p><p>Define a cor de fundo do botão, quando não está pressionado. O valor padrão desta propriedade é cinza</p><p>(RGB(192, 192, 192)).</p><p>BackgroundColor1</p><p>Define a cor de fundo do botão, quando está pressionado. O valor padrão desta propriedade é cinza (RGB(192,</p><p>192, 192)).</p><p>Bitmap0</p><p>Define a imagem do botão, quando não está pressionado. O valor padrão desta propriedade é vazio.</p><p>Bitmap1</p><p>Define a imagem do botão, quando está pressionado. O valor padrão desta propriedade é vazio.</p><p>Text0</p><p>Define o texto do botão, quando não está pressionado. O valor padrão desta propriedade é "DESLIGADO".</p><p>Text1</p><p>Define o texto do botão, quando está pressionado. O valor padrão desta propriedade é "LIGADO".</p><p>TextColor0</p><p>Define a cor do texto do botão, quando não está pressionado. O valor padrão desta propriedade é preto (RGB(0,</p><p>0, 0)).</p><p>TextColor1</p><p>Define a cor do texto do botão, quando está pressionado. O valor padrão desta propriedade é preto (RGB(0, 0,</p><p>0)).</p><p>TextFont0</p><p>Esta propriedade é utilizada para determinar a fonte deste botão quando não está pressionado. Esta propriedade</p><p>não pode ser utilizada em scripts ou em Associações, sendo configurada unicamente via Elipse E3 Studio. Consulte o</p><p>tópico Fonte para mais informações sobre as subpropriedades desta propriedade.</p><p>Visualização</p><p>114</p><p>TextFont1</p><p>Esta propriedade é utilizada para determinar a fonte deste botão quando está pressionado. Esta propriedade não</p><p>pode ser utilizada em scripts ou em Associações, sendo configurada unicamente via Elipse E3 Studio. Consulte o</p><p>tópico Fonte para mais informações sobre as subpropriedades desta propriedade.</p><p>Type</p><p>Define o tipo do botão. Os valores possíveis para esta propriedade são 0 - ButtonTypeKey: Comportamento</p><p>normal de um botão (padrão), 1 - ButtonTypeSwitchH: O comportamento do botão é o de uma chave dividida</p><p>horizontalmente, 2 - ButtonTypeSwitchV: O comportamento do botão é o de uma chave dividida verticalmente, 3 -</p><p>ButtonTypeLeverH: O comportamento do botão é o de uma alavanca que se movimenta da esquerda para a direita e</p><p>vice-versa, 4 - ButtonTypeLeverV: O comportamento do botão é o de uma alavanca que se movimenta de cima para</p><p>baixo e vice-versa, 5 - ButtonTypeTransparent: O botão é transparente, 6 - ButtonTypeUserBitmap: O botão alterna</p><p>a exibição das imagens definidas nas propriedades Bitmap0 e Bitmap1, 7 - ButtonTypeCheckbox: O comportamento</p><p>do botão é o mesmo de uma Caixa de Seleção ou 8 - ButtonTypeRadio: O comportamento do botão é o mesmo de</p><p>um Botão de Opções.</p><p>Value</p><p>Esta propriedade é um Variant que assume o valor contido na propriedade Value0 se o botão não está</p><p>pressionado, e o valor contido na propriedade Value1 se o botão está pressionado.</p><p>Value0</p><p>Define o valor da propriedade Value, quando o botão não está pressionado.</p><p>Value1</p><p>Define o valor da propriedade Value, quando o botão está pressionado.</p><p>4.3.2.8.5 E2Display</p><p>Esta seção contém informações sobre propriedades do objeto E2Display. Este objeto não possui eventos nem</p><p>métodos associados.</p><p>4.3.2.8.5.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto E2Display.</p><p>BackgroundColor</p><p>Esta propriedade define a cor de fundo do objeto. O valor padrão desta propriedade é cinza (RGB(192, 192, 192)).</p><p>BackgroundStyle</p><p>Define o estilo de fundo do objeto. Os valores possíveis para esta propriedade são 0 - bsTransparent: O fundo é</p><p>transparente ou 1 - bsOpaque: A cor definida em BackgroundColor é vísivel (padrão).</p><p>Format</p><p>Contém um texto que representa uma máscara, dentro da qual os valores do objeto são mostrados. Esta máscara</p><p>pode representar vários tipos de valores:</p><p>· Geral: Não possui formatação específica, adaptando-se automaticamente ao valor especificado</p><p>· Número: Apresenta números com parte inteira e fracionária. O usuário pode optar por até 15 casas decimais, por</p><p>usar ou não um separador de milhares, e por apresentar números negativos com sinal ou entre parênteses. Para</p><p>números muito grandes ou muito pequenos, recomenda-se utilizar o formato Científico</p><p>· Data: Apresenta valores numéricos de data e hora (quando válidos). Para representar apenas a hora, use o</p><p>formato equivalente</p><p>· Hora: Apresenta valores numéricos de hora e data (quando válidos). Para representar apenas a data, use o</p><p>formato equivalente</p><p>· Porcentagem: Multiplica o número por 100 e adiciona o símbolo de porcentagem. Admite até 15 casas decimais</p><p>· Científico: Apresenta o número em notação de mantissa e expoente. Ideal para números de magnitude variada.</p><p>Admite até 15 casas decimais</p><p>· Especial: Permite formatar números inteiros em bases não decimais (hexadecimal, octal ou binária, por exemplo)</p><p>· Outro: Permite editar diretamente o código de formatação desejado, ou selecionar um formato criado</p><p>anteriormente</p><p>115</p><p>Visualização</p><p>HorizontalAlignment</p><p>Define o alinhamento horizontal do texto do E2Display. Os valores possíveis para esta propriedade são 0 -</p><p>HorizontalAlignmentLeft: Alinha horizontalmente à esquerda, 1 - HorizontalAlignmentCenter: Alinha</p><p>horizontalmente ao centro (padrão) ou 2 - HorizontalAlignmentRight: Alinha horizontalmente à direita.</p><p>MultiLine</p><p>Define se o objeto possui múltiplas linhas ou não. Esta propriedade só tem efeito se a propriedade Value é do tipo</p><p>String.</p><p>TextColor</p><p>Define a cor do texto do objeto. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).</p><p>TextFont</p><p>Esta propriedade é utilizada para determinar a fonte deste objeto. Esta propriedade não pode ser utilizada em</p><p>Associações. Consulte o tópico Fonte para mais informações sobre as subpropriedades desta propriedade.</p><p>Value</p><p>Esta propriedade contém um Variant que pode assumir valores de todo e qualquer tipo de dados, e a forma de</p><p>apresentação destes valores é definida pela propriedade Format.</p><p>VerticalAlignment</p><p>Define o alinhamento vertical do texto do E2Display. Os valores possíveis para esta propriedade são 0 -</p><p>VerticalAlignmentTop: Alinha verticalmente com a parte superior do objeto, 1 - VerticalAlignmentMiddle: Alinha</p><p>verticalmente com o centro</p><p>do objeto (padrão) ou 2 - VerticalAlignmentBottom: Alinha verticalmente com a parte</p><p>inferior do objeto.</p><p>4.3.2.8.6 E2Gauge</p><p>Esta seção contém informações sobre propriedades do objeto E2Gauge. Este objeto não possui eventos nem</p><p>métodos associados.</p><p>4.3.2.8.6.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto E2Gauge.</p><p>BackgroundColor</p><p>Esta propriedade define a cor de fundo do objeto. O valor padrão desta propriedade é cinza (RGB(128, 128, 128)).</p><p>BulletsVisible</p><p>Exibe ou esconde as marcas da escala em forma de bullet.</p><p>DecimalPlaces</p><p>Esta propriedade define o número de casas decimais para o valor nominal do E2Gauge.</p><p>FrameColor</p><p>Define a cor de fundo do objeto.</p><p>HiColorLegend</p><p>Define a cor da legenda para o limite Alto. O valor padrão desta propriedade é amarelo (RGB(255, 255, 0)).</p><p>HiDiv</p><p>Marca o início da escala para o limite Alto. O valor padrão desta propriedade é 13300.</p><p>HiHiColorLegend</p><p>Define a cor da legenda para o limite Muito Alto. O valor padrão desta propriedade é vermelho (RGB(255, 0, 0)).</p><p>HiHiDiv</p><p>Marca o início da escala para o limite Muito Alto. O valor padrão desta propriedade é 16600.</p><p>HiHiLimitVisible</p><p>Habilita ou desabilita a exibição do limite Muito Alto.</p><p>HiLimit</p><p>O valor máximo dessa propriedade é 1 (um) e o mínimo é limitado pela propriedade LowLimit. O valor padrão</p><p>desta propriedade é 0,7.</p><p>Visualização</p><p>116</p><p>HiLimitVisible</p><p>Habilita ou desabilita a exibição do limite Alto.</p><p>LegendVisible</p><p>Exibe uma barra ao longo do objeto E2Gauge, onde podem ser configuradas diferentes cores, dependendo da</p><p>faixa de valores. O valor padrão desta propriedade é Verdadeiro.</p><p>LimitVisible</p><p>Define se os valores mínimos e máximos da escala aparecem ou não no gráfico.</p><p>LowColorLegend</p><p>Define a cor da legenda para o limite Baixo. O valor padrão desta propriedade é verde escuro (RGB(0, 128, 0)).</p><p>LowDiv</p><p>Marca o início da escala para o limite Baixo. O valor padrão desta propriedade é 6600.</p><p>LowLimit</p><p>O valor mínimo desta propriedade é 0,1 e o máximo é limitado pela propriedade HiLimit. O valor padrão desta</p><p>propriedade é 0,62.</p><p>LowLimitVisible</p><p>Habilita ou desabilita a exibição do limite Baixo.</p><p>LowLowColorLegend</p><p>Define a cor da legenda para o limite Muito Baixo. O valor padrão desta propriedade é verde (RGB(0, 255, 0)).</p><p>LowLowDiv</p><p>Marca o início da escala para o limite Muito Baixo. O valor padrão desta propriedade é 3300.</p><p>LowLowLimitVisible</p><p>Habilita ou desabilita a exibição do limite Muito Baixo.</p><p>Maximum</p><p>Define o valor máximo da escala do E2Gauge.</p><p>Minimum</p><p>Define o valor mínimo da escala do E2Gauge.</p><p>NeedleColor</p><p>Define a cor do ponteiro do E2Gauge. O valor padrão desta propriedade é branco (RGB(255, 255, 255)).</p><p>NeedleThickness</p><p>Define a espessura do ponteiro do E2Gauge, em pixels. O valor padrão desta propriedade é 2 (dois), e só são</p><p>aceitos os valores 1 (um) ou 2 (dois).</p><p>NormalColor</p><p>Define a cor da legenda para o limite Normal. O valor padrão desta propriedade é oliva (RGB(128, 128, 0)).</p><p>NumberOfPoints</p><p>Define o número de subdivisões que estão visíveis na escala do objeto.</p><p>Orientation</p><p>Define a orientação do objeto E2Gauge. Os valores possíveis para esta propriedade são 0 - Left: A parte inferior</p><p>do objeto está alinhada com o lado esquerdo da moldura, 1 - Up: A parte inferior do objeto está alinhada com a</p><p>parte de cima da moldura, 2 - Down: A parte inferior do objeto está alinhada com a parte de baixo da moldura</p><p>(padrão) ou 3 - Right: A parte inferior do objeto está alinhada com o lado direito da moldura.</p><p>Reverted</p><p>Habilita ou desabilita a reversão da escala do objeto.</p><p>ShowFrame</p><p>Habilita ou desabilita a exibição do fundo ao longo do percurso do ponteiro.</p><p>StartAngle</p><p>Define o ângulo inicial de exibição do ponteiro do objeto E2Gauge.</p><p>SubTickColor</p><p>Define a cor das subdivisões da escala. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).</p><p>117</p><p>Visualização</p><p>SubTicksVisible</p><p>Habilita ou desabilita a exibição das subdivisões da escala.</p><p>TextColor</p><p>Define a cor do texto da escala. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).</p><p>TextFont</p><p>Esta propriedade é utilizada para determinar a fonte do texto da escala. Esta propriedade não pode ser utilizada</p><p>em Associações. Consulte o tópico Fonte para mais informações sobre as subpropriedades desta propriedade.</p><p>ThickTicks</p><p>Habilita ou desabilita a exibição de divisores da escala mais espessos. O valor padrão desta propriedade é Falso.</p><p>TickColor</p><p>Define a cor dos divisores da escala. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).</p><p>TicksVisible</p><p>Habilita ou desabilita a exibição das divisões da escala.</p><p>TickValues</p><p>Habilita ou desabilita a exibição dos valores das divisões da escala.</p><p>TotalNumberOfSubTicks</p><p>Define o número total de subdivisões que são mostradas na escala.</p><p>Value</p><p>Esta propriedade define um valor entre as propriedades Maximum e Minimum da escala do objeto.</p><p>ValueVisible</p><p>Habilita ou desabilita a exibição do valor contido na propriedade Value. O valor padrão desta propriedade é Falso.</p><p>4.3.2.8.7 E2Setpoint</p><p>Esta seção contém informações sobre propriedades do objeto E2Setpoint. Este objeto não possui eventos nem</p><p>métodos associados.</p><p>4.3.2.8.7.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto E2Setpoint.</p><p>AutoSend</p><p>Se esta propriedade está em Verdadeiro (valor padrão), o valor definido na propriedade Value é atualizado nas</p><p>Associações assim que o objeto perder o foco. Caso contrário, as Associações só recebem o valor quando é usada a</p><p>tecla ENTER.</p><p>BackgroundColor</p><p>Esta propriedade define a cor de fundo do objeto. O valor padrão desta propriedade é cinza (RGB(192, 192, 192)).</p><p>BackgroundStyle</p><p>Define o estilo de fundo do objeto. Os valores possíveis para esta propriedade são 0 - bsTransparent: O fundo é</p><p>transparente ou 1 - bsOpaque: A cor definida em BackgroundColor é vísivel (padrão).</p><p>EnableMaxLimit</p><p>Habilita ou desabilita a definição de um limite máximo para o valor do E2Setpoint.</p><p>EnableMinLimit</p><p>Habilita ou desabilita a definição de um limite mínimo para o valor do E2Setpoint.</p><p>Format</p><p>Contém um texto que representa uma máscara, dentro da qual os valores do objeto são mostrados. Esta máscara</p><p>pode representar vários tipos de valores:</p><p>· Geral: Não possui formatação específica, adaptando-se automaticamente ao valor especificado</p><p>· Número: Apresenta números com parte inteira e fracionária. O usuário pode optar por até 15 casas decimais, por</p><p>usar ou não um separador de milhares, e por apresentar números negativos com sinal ou entre parênteses. Para</p><p>números muito grandes ou muito pequenos, recomenda-se utilizar o formato Científico</p><p>Visualização</p><p>118</p><p>· Data: Apresenta valores numéricos de data e hora (quando válidos). Para representar apenas a hora, use o</p><p>formato equivalente</p><p>· Hora: Apresenta valores numéricos de hora e data (quando válidos). Para representar apenas a data, use o</p><p>formato equivalente</p><p>· Porcentagem: Multiplica o número por 100 e adiciona o símbolo de porcentagem. Admite até 15 casas decimais</p><p>· Científico: Apresenta o número em notação de mantissa e expoente. Ideal para números de magnitude variada.</p><p>Admite até 15 casas decimais</p><p>· Especial: Permite formatar números inteiros em bases não decimais (hexadecimal, octal ou binária, por exemplo)</p><p>· Outro: Permite editar diretamente o código de formatação desejado, ou selecionar um formato criado</p><p>anteriormente</p><p>HorizontalAlignment</p><p>Define o alinhamento horizontal do texto do E2Setpoint. <%TEXT_POSSILBE_VALUE%> 0 -</p><p>HorizontalAlignmentLeft: Alinha horizontalmente à esquerda, 1 -</p><p>HorizontalAlignmentCenter: Alinha</p><p>horizontalmente ao centro (padrão) ou 2 - HorizontalAlignmentRight: Alinha horizontalmente à direita.</p><p>HScroll</p><p>Habilita ou desabilita a exibição de uma barra de rolagem horizontal no texto, caso a propriedade Multiline esteja</p><p>em Verdadeiro.</p><p>MaxLimit</p><p>Limite máximo que pode ser atingido pela propriedade Value do objeto. O valor padrão desta propriedade é 200.</p><p>O limite só é verificado se a propriedade EnableMaxLimit está habilitada.</p><p>MinLimit</p><p>Limite mínimo que pode ser atingido pela propriedade Value do objeto. O valor padrão desta propriedade é 0</p><p>(zero). O limite só é verificado se a propriedade EnableMinLimit está habilitada.</p><p>MultiLine</p><p>Define se o objeto possui múltiplas linhas ou não. Esta propriedade só está disponível se a propriedade Value é do</p><p>tipo String.</p><p>ReadOnly</p><p>Indica se o objeto pode ser editado ou não em tempo de execução. O valor padrão desta propriedade é Falso.</p><p>Refresh</p><p>Indica se o valor do E2Setpoint é atualizado ou não sempre que o valor do Tag mudar. O valor padrão desta</p><p>propriedade é Verdadeiro.</p><p>SelectAllOnFocus</p><p>Habilita ou desabilita a seleção de todos os caracteres do E2Setpoint quando o objeto recebe o foco. O valor</p><p>padrão desta propriedade é Verdadeiro.</p><p>TextColor</p><p>Define a cor do texto do objeto. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).</p><p>TextFont</p><p>Esta propriedade é utilizada para determinar a fonte deste objeto. Esta propriedade não pode ser utilizada</p><p>Associações. Consulte o tópico Fonte para mais informações sobre as subpropriedades desta propriedade.</p><p>Type</p><p>Define o tipo de Setpoint. Os valores possíveis para esta propriedade são 0 - setpointString: Aceita quaisquer</p><p>caracteres alfanuméricos, 1 - setpointNumeric: Aceita somente caracteres numéricos e o separador decimal (ponto</p><p>ou vírgula, dependendo das configurações regionais, padrão) ou 2 - setpointDateTime: Aceita somente valores de</p><p>data e hora, que são convertidos para o formato definido nas configurações regionais.</p><p>Value</p><p>Esta propriedade define um valor para o E2Setpoint. A forma como este valor é visualizado é definida na</p><p>propriedade Format.</p><p>VerticalAlignment</p><p>Define o alinhamento vertical do texto do E2Setpoint. Os valores possíveis para esta propriedade são 0 -</p><p>VerticalAlignmentTop: Alinha verticalmente com a parte superior do objeto, 1 - VerticalAlignmentMiddle: Alinha</p><p>119</p><p>Visualização</p><p>verticalmente com o centro do objeto (padrão) ou 2 - VerticalAlignmentBottom: Alinha verticalmente com a parte</p><p>inferior do objeto.</p><p>VScroll</p><p>Habilita ou desabilita a exibição de uma barra de rolagem vertical no texto, caso a propriedade Multiline esteja em</p><p>Verdadeiro.</p><p>4.3.2.8.8 E2Text</p><p>Esta seção contém informações sobre propriedades do objeto E2Text. Este objeto não possui eventos nem métodos</p><p>associados.</p><p>4.3.2.8.8.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto E2Text.</p><p>BlinkTime</p><p>Define o intervalo de tempo, em milissegundos, do efeito de piscar do objeto.</p><p>DefaultZone</p><p>Define a Zona padrão do objeto.</p><p>Value</p><p>Esta propriedade contém um Variant que pode assumir valores de todo e qualquer tipo de dados, tais como</p><p>Integer, Boolean ou String, entre outros.</p><p>Zones</p><p>Coleção de Zonas do objeto E2Text. Esta propriedade é somente de leitura.</p><p>4.3.2.8.8.2 Coleção de Zonas</p><p>Esta seção contém informações sobre métodos do objeto Coleção de Zonas do objeto E2Text (TextZoneCollection).</p><p>Este objeto não possui eventos nem propriedades associadas.</p><p>Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Coleção de Zonas do E2Text (TextZoneCollection).</p><p>Add</p><p>Add([AxisName])</p><p>Adiciona uma nova Zona na Coleção de Zonas. O parâmetro AxisName é opcional e não tem efeito, sendo mantido</p><p>por questões de compatibilidade com versões anteriores.</p><p>Remove</p><p>Remove(Index)</p><p>Remove uma Zona. O parâmetro Index indica o índice da Zona que deve ser removida.</p><p>Zonas</p><p>As Zonas definem um conjunto de Zonas de Texto (TextZone) para o objeto E2Text. Estas Zonas podem ser</p><p>configuradas acessando a janela de propriedades do objeto, na aba Zonas. As opções disponíveis nesta aba estão</p><p>descritas na tabela a seguir.</p><p>Opções disponíveis na aba Zonas</p><p>OPÇÃO DESCRIÇÃO</p><p>Zonas Listagem com todas as Zonas definidas no objeto</p><p>Adicionar Adiciona uma nova Zona</p><p>Remover Remove a Zona selecionada</p><p>Pisca a cada (ms) Define se o texto e o fundo da Zona piscam quando o</p><p>valor do objeto estiver dentro do intervalo da Zona</p><p>Mensagem Texto da mensagem exibida quando o valor do objeto</p><p>estiver dentro do intervalo da Zona</p><p>Alinhamento Define o alinhamento do texto</p><p>Visualização</p><p>120</p><p>OPÇÃO DESCRIÇÃO</p><p>Fonte Define a fonte do texto</p><p>Cor de fundo Define a cor de fundo da Zona</p><p>Transparente Define se o fundo do objeto é transparente quando a</p><p>Zona estiver ativa</p><p>Zona padrão Define a Zona selecionada como a Zona padrão do</p><p>objeto</p><p>Pisca Define se a Zona pisca quando o valor do objeto estiver</p><p>dentro do intervalo da Zona</p><p>Mínimo Valor mínimo para a Zona</p><p>Máximo Valor máximo para a Zona</p><p>Dica Mostra um texto de ajuda para a Zona</p><p>Exemplo Mostra um exemplo do comportamento da Zona em</p><p>tempo de execução</p><p>A seção a seguir contém informações sobre as propriedades do objeto Zona de uma Coleção de Zonas de um objeto</p><p>E2Text (TextZone). Este objeto não possui eventos nem métodos associados.</p><p>Propriedades</p><p>Esta seção contém informações sobre as propriedades dos objetos Zona (TextZone) de um objeto E2Text.</p><p>BackgroundColor</p><p>Define a cor de fundo do texto da Zona. O valor padrão desta propriedade é branco (RGB(255, 255, 255)).</p><p>Blink</p><p>Indica que esta Zona participa do efeito de piscar. O valor padrão desta propriedade é Falso. Se está habilitada,</p><p>esta Zona alterna com a Zona padrão, conforme o tempo definido na propriedade BlinkTime do objeto E2Text.</p><p>HorizontalAlignment</p><p>Define o alinhamento do texto. Os valores possíveis para esta propriedade são 0 - HorizontalAlignmentLeft:</p><p>Alinha horizontalmente à esquerda, 1 - HorizontalAlignmentCenter: Alinha horizontalmente ao centro (padrão) ou 2 -</p><p>HorizontalAlignmentRight: Alinha horizontalmente à direita.</p><p>Maximum</p><p>Define o valor máximo para a Zona. O valor padrão desta propriedade é 20000.</p><p>Message</p><p>Define o texto associado à Zona. Esta mensagem é mostrada quando o Tag associado está dentro dos limites da</p><p>Zona.</p><p>Minimum</p><p>Define o valor mínimo para a Zona. O valor padrão desta propriedade é 0 (zero).</p><p>TextColor</p><p>Define a cor do texto da Zona. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).</p><p>TextFont</p><p>Define o estilo, a cor e o tamanho da fonte usada para mostrar o texto da mensagem. Esta propriedade não pode</p><p>ser utilizada em Associações. Consulte o tópico Fonte para mais informações sobre as subpropriedades desta</p><p>propriedade.</p><p>TipEnable</p><p>Habilita ou desabilita a dica para a Zona. O valor padrão desta propriedade é Falso.</p><p>TipText</p><p>Define o texto da dica para a Zona. O valor padrão desta propriedade é uma String vazia.</p><p>Transparent</p><p>Define que o fundo do objeto é transparente quando esta Zona está ativa.</p><p>121</p><p>Visualização</p><p>4.3.2.9 Elipse KeyPad</p><p>Esta seção contém informações sobre métodos e propriedades do objeto Elipse KeyPad. Este objeto não possui</p><p>eventos associados.</p><p>4.3.2.9.1 Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Elipse KeyPad.</p><p>4.3.2.9.1.1 Hide</p><p>Hide()</p><p>Oculta o Elipse KeyPad. Este método não tem efeito se o KeyPad já está invisível.</p><p>4.3.2.9.1.2 Show</p><p>Show()</p><p>Mostra o Elipse KeyPad. Este método não tem efeito se o KeyPad já está visível na tela.</p><p>4.3.2.9.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades</p><p>do objeto Elipse KeyPad.</p><p>4.3.2.9.2.1 AutoHideOnEnter</p><p>Automaticamente oculta o KeyPad quando a tecla ENTER do teclado virtual é pressionada.</p><p>4.3.2.9.2.2 AutoHideOnEsc</p><p>Automaticamente oculta o KeyPad quando a tecla ESC do teclado virtual é pressionada.</p><p>4.3.2.9.2.3 Layout</p><p>Permite alterar o layout de apresentação do KeyPad. Os valores possíveis para esta propriedade são os seguintes:</p><p>· br-simple: Mostra um teclado alfanumérico</p><p>Exemplo de KeyPad alfanumérico</p><p>· num: Mostra um teclado numérico</p><p>Visualização</p><p>122</p><p>Exemplo de KeyPad numérico</p><p>O script a seguir contém um exemplo de uso desta propriedade.</p><p>' Alterna entre os modos Alfanumérico e Numérico</p><p>Sub ToggleButton1_Click()</p><p>If ToggleButton1.Value Then</p><p>Application.GetKeyPad().Layout = "br-simple"</p><p>Else</p><p>Application.GetKeyPad().Layout = "num"</p><p>End If</p><p>End Sub</p><p>4.3.2.9.2.4 SizeFactor</p><p>Aumenta ou diminui o tamanho original do KeyPad, utilizando um fator de multiplicação. O tamanho original do</p><p>KeyPad é mostrado na tabela a seguir.</p><p>Valores padrão de tamanho do KeyPad</p><p>LAYOUT LARGURA ALTURA</p><p>Alfanumérico 550 px 250 px</p><p>Numérico 200 px 300 px</p><p>O exemplo a seguir redimensiona o KeyPad para 75% do tamanho original.</p><p>Sub Botao1_Click()</p><p>Application.GetKeyPad().SizeFactor = 0.75</p><p>Application.GetKeyPad().Show()</p><p>End Sub</p><p>4.3.2.9.2.5 Sound</p><p>Permite alterar o som emitido ao clicar-se em uma tecla do KeyPad. O valor padrão desta propriedade é uma</p><p>String vazia, significando que nenhum som é emitido ao clicar-se em uma tecla. Caso seja alterado o valor desta</p><p>propriedade, é necessário que o novo valor seja o caminho absoluto de um arquivo no formato WAV ou então que</p><p>este arquivo esteja incluído no Domínio como um Recurso.</p><p>4.3.2.9.2.6 X</p><p>A coordenada X do canto superior esquerdo do objeto KeyPad. Esta propriedade pode ser usada para mover o</p><p>KeyPad no sentido horizontal.</p><p>4.3.2.9.2.7 Y</p><p>A coordenada Y do canto superior esquerdo do objeto KeyPad. Esta propriedade pode ser usada para mover o</p><p>KeyPad no sentido vertical.</p><p>123</p><p>Visualização</p><p>4.3.2.10 Escala</p><p>Esta seção contém informações sobre propriedades do objeto Escala (DrawScale). Este objeto não possui eventos</p><p>nem métodos associados.</p><p>4.3.2.10.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Escala (DrawScale).</p><p>4.3.2.10.1.1 BackgroundColor</p><p>Esta propriedade especifica a cor de preenchimento do fundo do objeto. Esta cor é utilizada quando a propriedade</p><p>BackgroundStyle está configurada para 1 (um, opaco) e umas das propriedades VerticalPercentFill ou</p><p>HorizontalPercentFill está com valores diferentes de 100. Outro uso desta cor é quando a propriedade FillStyle está</p><p>configurada entre os valores 2 (dois) e 8 (oito). Isto permite que a área restante utilize a cor de fundo para</p><p>preenchimento. Nos scripts, utilize o método RGB do VBScript para montar a cor a ser associada a esta propriedade.</p><p>O valor padrão desta propriedade é cinza (RGB(192, 192, 192)).</p><p>4.3.2.10.1.2 BorderColor</p><p>Esta propriedade determina a cor da borda que é aplicada no objeto Escala. Com esta propriedade, é possível</p><p>aplicar a cor padrão ou personalizá-la através da edição. O valor padrão desta propriedade é branco (RGB(255, 255,</p><p>255)). O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub Escala1_Click()</p><p>BorderColor = RGB (255, 0, 0)</p><p>End Sub</p><p>4.3.2.10.1.3 BorderStyle</p><p>Esta propriedade determina o estilo de borda que é aplicada ao objeto Escala. Os valores possíveis para esta</p><p>propriedade estão descritos na tabela a seguir.</p><p>Opções disponíveis para a propriedade BorderStyle</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - Normal Aplica uma borda sólida na grade vertical da escala</p><p>1 - Dash Aplica uma borda de linha tracejada na escala</p><p>2 - Dot Aplica uma borda pontilhada na escala</p><p>3 - DashDot Aplica uma borda de traço e ponto na escala</p><p>4 - DashDotDot Aplica uma borda de traço, ponto e ponto na escala</p><p>5 - Null O objeto não tem borda (padrão)</p><p>4.3.2.10.1.4 BorderWidth</p><p>Esta propriedade determina a largura, em pixels, da borda do objeto Escala. Através desta propriedade, é possível</p><p>configurar a largura da borda sem precisar modificar a estrutura. O valor padrão desta propriedade é 0 (zero).</p><p>4.3.2.10.1.5 ForegroundColor</p><p>Esta propriedade especifica a cor do preenchimento da frente do objeto. Esta cor é utilizada quando a propriedade</p><p>FillStyle está configurada para 0 (zero, sólido) ou entre 2 (dois) e 9 (nove). Nos scripts, utilize o método RGB do</p><p>VBScript para montar a cor a ser associada a esta propriedade. O valor padrão desta propriedade é azul (RGB(0, 0,</p><p>255)). O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub Botao1_Click()</p><p>' Troca a cor de fundo do botao para verde</p><p>'quando se clica no objeto</p><p>ForegroundColor = RGB(0, 255, 0)</p><p>End Sub</p><p>4.3.2.10.1.6 Format</p><p>Esta propriedade especifica que tipo de formato é atribuído ao objeto. Permite mudar a forma como os dados são</p><p>apresentados sem mudar o valor existente por trás destes dados. Esta propriedade pode ser editada manualmente</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>Visualização</p><p>124</p><p>ou configurada através da janela de formatação. O uso é semelhante aos formatadores usados nas planilhas de</p><p>dados, seguindo a mesma sintaxe. A tabela a seguir contém os tipos de dados suportados.</p><p>Tipos de dados suportados pela propriedade Format</p><p>TIPO DE DADOS DESCRIÇÃO</p><p>Numérico Saída decimal, científica, hexadecimal, binária ou octal</p><p>Texto Textos em geral</p><p>Booleano Valores Booleanos</p><p>Data/Hora Calendário Gregoriano</p><p>4.3.2.10.1.7 LineColor</p><p>Determina a cor da linha com as marcas divisórias e subdivisórias da Escala. Para determinar a cor da legenda com</p><p>números do objeto, use a propriedade TextColor. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).</p><p>4.3.2.10.1.8 MaximumValue</p><p>Esta propriedade determina o valor máximo atingido pela Escala. O valor padrão desta propriedade é 100. O script</p><p>a seguir contém um exemplo de uso desta propriedade.</p><p>Sub CommandButton_Click()</p><p>' Ao clicar no botão, abre um MessageBox indicando</p><p>' o valor máximo da propriedade da escala</p><p>MsgBox CSTr(Screen.Item("Escala1").MaximumValue)</p><p>End Sub</p><p>4.3.2.10.1.9 MinimumValue</p><p>Esta propriedade determina o valor mínimo requerido pela Escala. O valor padrão desta propriedade é 0 (zero). O</p><p>script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub CommandButton1_Click()</p><p>' Ao clicar no botão, abre um MessageBox indicando</p><p>' o valor da propriedade Minimum do Escala1</p><p>MsgBox _</p><p>CSTr(Application.GetObject("Dados.Escala1").MinimumValue)</p><p>End Sub</p><p>4.3.2.10.1.10 MinorTicks</p><p>Esta propriedade determina a quantidade de marcas da Escala. O valor padrão desta propriedade é 3 (três). O</p><p>script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub CommandButton1_Click()</p><p>' Mostra o total de marcas da escala</p><p>MsgBox CStr(Screen.Item("Escala1").MinorTicks)</p><p>End Sub</p><p>4.3.2.10.1.11 MinorTicksPercentSize</p><p>Esta propriedade determina o tamanho das marcas que subdividem cada medida do objeto Escala. O valor padrão</p><p>desta propriedade é 10.</p><p>4.3.2.10.1.12 ScaleAlignment</p><p>Esta propriedade determina o tipo de alinhamento que é atribuído à Escala. Os valores possíveis para esta</p><p>propriedade são 0 - RightSide: À direita (padrão) ou 1 - LeftSide: À esquerda.</p><p>4.3.2.10.1.13 ShowText</p><p>Esta propriedade determina a visibilidade do texto na legenda do objeto Escala. Se esta propriedade está</p><p>habilitada, o texto é mostrado. Caso contrário, o objeto mostra somente as linhas</p><p>e subdivisões da Escala. O valor</p><p>padrão desta propriedade é Verdadeiro.</p><p>4.3.2.10.1.14 StretchText</p><p>Esta propriedade determina a aplicação de extensão (stretch) ao texto do objeto Escala. Caso a largura ou altura da</p><p>Escala sejam alteradas, o texto acompanha esta variação. Se esta propriedade está habilitada, o objeto acompanha as</p><p>125</p><p>Visualização</p><p>variações de altura e largura do objeto conforme seja transformado. Caso contrário, o texto permanece com as</p><p>configurações iniciais. O valor padrão desta propriedade é Falso.</p><p>4.3.2.10.1.15 TextAlignment</p><p>Esta propriedade determina o alinhamento do texto no objeto. Os valores possíveis para esta propriedade estão</p><p>descritos na tabela a seguir.</p><p>Opções disponíveis para a propriedade TextAlignment</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - LeftAlignment O alinhamento do texto é à esquerda (padrão)</p><p>1 - CenterAlignment O alinhamento do texto é centralizado</p><p>2 - RightAlignment O alinhamento do texto é à direita</p><p>4.3.2.10.1.16 TextColor</p><p>Determina a cor da fonte aplicada na legenda com números do objeto Escala. Para determinar a cor da linha com</p><p>as marcas divisórias e subdivisórias da Escala, utilize a propriedade LineColor. O valor padrão desta propriedade é</p><p>preto (RGB(0, 0, 0)).</p><p>4.3.2.10.1.17 TextFont</p><p>Esta propriedade determina a fonte que é aplicada na Escala. A fonte selecionada é aplicada em todo o objeto</p><p>Escala. Esta propriedade não pode ser utilizada em Associações e as sub-propriedades podem ser consultadas no</p><p>tópico Fonte.</p><p>4.3.2.10.1.18 Ticks</p><p>Determina a quantidade de divisórias que a Escala tem. O valor padrão desta propriedade é 5 (cinco).</p><p>4.3.2.10.1.19 TicksPercentSize</p><p>Determina o tamanho das linhas que dividem o objeto Escala. Conforme for o valor especificado nesta propriedade,</p><p>maior ou menor é o tamanho da linha da divisória padrão da Escala. O valor padrão desta propriedade é 20.</p><p>4.3.2.11 Figura</p><p>Esta seção contém informações sobre métodos e propriedades do objeto Figura (DrawPicture). Este objeto não</p><p>possui eventos associados.</p><p>4.3.2.11.1 Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Figura (DrawPicture).</p><p>4.3.2.11.1.1 ScaleImage</p><p>ScaleImage(PercX, PercY, AnchorType)</p><p>Este método permite ajustar o tamanho de uma Figura proporcionalmente ao tamanho original. Os parâmetros PercX</p><p>e PercY definem, respectivamente, os tamanhos percentuais horizontal e vertical da Figura em relação ao tamanho</p><p>original. O parâmetro AnchorType define um ponto de ancoragem para este ajuste. Os valores possíveis para este</p><p>parâmetro são 0: Center (mantém fixo o centro da Figura), 3: TopLeft (mantém fixo o canto esquerdo superior da</p><p>Figura), 4: BottomLeft (mantém fixo o canto esquerdo inferior da Figura), 5: BottomRight (mantém fixo o canto direito</p><p>inferior da Figura) ou 6: TopRight (mantém fixo o canto direito superior da Figura).</p><p>4.3.2.11.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Figura (DrawPicture).</p><p>4.3.2.11.2.1 BackgroundColor</p><p>Esta propriedade especifica a cor de preenchimento do fundo do objeto. Esta cor é utilizada quando a propriedade</p><p>BackgroundStyle está configurada para 1 (um, opaco) e umas das propriedades VerticalPercentFill ou</p><p>HorizontalPercentFill está com valores diferentes de 100. Nos scripts, utilize o método RGB do VBScript para montar</p><p>a cor a ser associada a esta propriedade. O valor padrão desta propriedade é cinza (RGB(192, 192, 192)).</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>Visualização</p><p>126</p><p>4.3.2.11.2.2 BackgroundStyle</p><p>Esta propriedade especifica o modo do preenchimento do fundo do objeto. Esta propriedade habilita a utilização</p><p>das propriedades VerticalPercentFill e HorizontalPercentFill com valores diferentes de 100, permitindo que a área</p><p>restante utilize a cor configurada na propriedade BackgroundColor para preenchimento. A tabela a seguir contém os</p><p>valores válidos para esta propriedade.</p><p>Opções disponíveis para a propriedade BackgroundStyle</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - Transparent Nenhum fundo deste objeto é desenhado</p><p>1 - Opaque Caso visível, o fundo é desenhado (padrão)</p><p>4.3.2.11.2.3 Convert</p><p>Esta propriedade permite a conversão da figura. Se esta propriedade está configurada em 0 (zero), é possível</p><p>visualizar a conversão. Caso contrário, não é possível visualizar a conversão. Esta propriedade só aceita os valores 0</p><p>(zero) e 1 (um). O valor padrão desta propriedade é 0 (zero).</p><p>4.3.2.11.2.4 EnableOverrideLineColor</p><p>Esta propriedade habilita ou desabilita o objeto a sobrescrever a cor original da linha da imagem pela cor definida</p><p>na propriedade OverrideLineColor. Se esta propriedade está habilitada, permite que seja modificada a cor original</p><p>da linha do objeto pela cor de OverrideLineColor. Caso contrário, o objeto Figura exibe a cor original.</p><p>4.3.2.11.2.5 Filename</p><p>Define o nome do arquivo de imagem associado a este objeto. O caminho do arquivo pode ser tanto o caminho</p><p>completo do arquivo no disco quanto o caminho relativo à aplicação, quando inserido o arquivo de imagem como um</p><p>Recurso da aplicação. O valor padrão desta propriedade é vazio. A tabela a seguir contém os tipos de arquivos de</p><p>imagem suportados.</p><p>Tipos de arquivos de imagem suportados</p><p>ARQUIVO FILTRO DESCRIÇÃO FILTRO</p><p>Bitmap BMP Não Sim</p><p>Graphics Interchange</p><p>Format</p><p>GIF Não Sim</p><p>Joint Photographic</p><p>Experts Group</p><p>JPG Não Sim</p><p>ICO File Format ICO Não Sim</p><p>Windows Metafile WMF Não Sim</p><p>Enhanced Metafile EMF Não Sim</p><p>Portable Network</p><p>Graphics</p><p>PNG Não Sim</p><p>Tagged Image File Format TIF Não Sim</p><p>4.3.2.11.2.6 HorizontalFillStyle</p><p>Define como é o preenchimento horizontal do objeto. Esta propriedade trabalha em conjunto com a propriedade</p><p>HorizontalPercentFill, que informa qual porcentagem do objeto deve ser preenchida. Estas duas propriedades</p><p>permitem uma simulação de um preenchimento de nível em um objeto, como ocorre em um nível de um tanque, por</p><p>exemplo.</p><p>Opções disponíveis para a propriedade HorizontalFillStyle</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - FillLeftToRight A porcentagem de preenchimento é da esquerda para a</p><p>direita (padrão)</p><p>127</p><p>Visualização</p><p>OPÇÃO DESCRIÇÃO</p><p>1 - FillRightToLeft A porcentagem de preenchimento é da direita para a</p><p>esquerda</p><p>2 - FillCenterToEdgesH A porcentagem de preenchimento é do centro para as</p><p>bordas</p><p>4.3.2.11.2.7 HorizontalPercentFill</p><p>Utilize esta propriedade para especificar qual a porcentagem da área horizontal do objeto deve ser preenchida. Os</p><p>valores aceitos por esta propriedade variam de 0 (zero) a 100. Esta propriedade trabalha em conjunto com a</p><p>propriedade HorizontalFillStyle, que informa como este preenchimento ocorre. O valor padrão desta propriedade é</p><p>100. O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub Circulo1_OnStartRunning()</p><p>HorizontalPercentFill = 200</p><p>End Sub</p><p>4.3.2.11.2.8 IgnoreFlipHorizontal</p><p>Esta propriedade força com que a imagem carregada neste objeto mantenha a orientação original em relação ao</p><p>eixo horizontal, independente da configuração da propriedade FlipHorizontal, comum a todos os objetos de Tela. O</p><p>valor padrão desta propriedade é Falso.</p><p>NOTAS</p><p>· Esta propriedade só tem efeito se o objeto Figura não foi convertido para símbolo, ou seja, a propriedade</p><p>Convert está configurada para o valor 0 (zero).</p><p>· Para objetos criados em versões anteriores à implementação desta propriedade e abertos em aplicações a partir</p><p>da versão 6.7, o valor desta propriedade é configurado para Verdadeiro.</p><p>4.3.2.11.2.9 IgnoreFlipVertical</p><p>Esta propriedade força com que a imagem carregada neste objeto mantenha a orientação original em relação</p><p>Repetir o evento Quando disponível, indica que o evento é do tipo</p><p>etWhileEvent, ou seja, o evento se repete enquanto a</p><p>expressão é verdadeira. Esta opção só está disponível</p><p>quando a opção Condição de Ocorrência está</p><p>configurada como Sempre que a expressão for</p><p>verdadeira. O intervalo de repetição é configurado na</p><p>opção Período (ms)</p><p>Período (ms) Intervalo de repetição, em milissegundos, do evento. Esta</p><p>opção só está disponível quando a opção Condição de</p><p>Ocorrência está configurada como Sempre que a</p><p>expressão for verdadeira e a opção Repetir o evento</p><p>está selecionada</p><p>13</p><p>Introdução</p><p>OPÇÃO DESCRIÇÃO</p><p>Tratar desconexão como mudança Indica que a conexão ou desconexão da expressão</p><p>geradora do evento deve ser tratada como mudança.</p><p>Esta opção só está disponível quando a opção Condição</p><p>de Ocorrência está configurada como Sempre que a</p><p>expressão alterar seu valor</p><p>4. Para alterar este evento usando a aba Scripts do objeto, selecione-o na lista de eventos. Um evento de usuário</p><p>também pode ser editado usando a opção Editar Associações do menu contextual de um objeto. Na janela Editar</p><p>Associações, clique na coluna Conexão correspondente a este evento e, no menu contextual, selecione a opção</p><p>Editar para abrir a janela da figura a seguir.</p><p>Janela Editar Eventos</p><p>Programando no Elipse E3</p><p>14</p><p>2</p><p>Programando no Elipse E3</p><p>CAPÍTULO</p><p>Apesar de a maioria dos aspectos do VBScript se aplicarem à programação de scripts no Elipse E3, algumas</p><p>particularidades devem ser destacadas no que diz respeito às implementações do conceito de orientação a objetos.</p><p>O VBScript é uma linguagem baseada no Visual Basic que traz a capacidade de scripting (roteirização) para aplicações</p><p>que executam no sistema operacional Windows.</p><p>O VBScript troca informações com as aplicações utilizando a tecnologia ActiveX Scripting. Com o ActiveX Scripting,</p><p>navegadores e outras aplicações cliente, como o Elipse E3 Viewer, podem compilar scripts e chamar funções, dentre</p><p>outros procedimentos. Isto possibilita que scripts desenvolvidos para uma aplicação ou biblioteca, que devam ser</p><p>executados na interface gráfica, possam ser executados tanto no Viewer quanto em um navegador de Internet, sem a</p><p>necessidade de qualquer adaptação do aplicativo.</p><p>Mais informações sobre o VBScript podem ser obtidas no VBScript Language Reference Guide.</p><p>2.1 Ambiente de Programação</p><p>O ambiente de programação de scripts no Elipse E3 Studio pode ser acessado ao clicar com o botão direito do</p><p>mouse em qualquer objeto e selecionar a opção Propriedades. Na aba Scripts do Editor do objeto, pode-se definir</p><p>qual evento é o gerador do script. Como visto no capítulo anterior, os tipos de eventos em um objeto do Elipse E3</p><p>são os Pré-Definidos e os Definidos pelo Usuário.</p><p>Os eventos pré-definidos variam de objeto para objeto, dependendo da utilização e funcionalidade. Um objeto de</p><p>Tela, por exemplo, possui eventos relacionados à interface gráfica, tais como Click (utilizado ao clicar em um objeto)</p><p>ou DblClick (utilizado com um duplo clique do mouse). Já um objeto como um Driver de Comunicação possui eventos</p><p>relacionados à comunicação, tal como OnCommError (utilizado quando há um erro de comunicação). Pode-se</p><p>também definir outros eventos para o objeto, como visto anteriormente.</p><p>Quando um script é associado a um evento em um objeto, o campo de digitação apresenta uma declaração de</p><p>procedimento (procedure), cuja definição é automática e composta do texto a seguir.</p><p>Sub NomeDoObjeto_NomeDoEvento()</p><p>End Sub</p><p>Nesta definição, NomeDoObjeto é o nome do objeto associado e NomeDoEvento é o nome do evento. Os comandos</p><p>do script devem estar entre estas duas linhas.</p><p>Para ajudar na digitação do script, pode-se utilizar o AppBrowser. Ao selecionar um método ou propriedade, pode-se</p><p>utilizar a opção Copiar. O Tag, propriedade ou método selecionado é inserido na posição do cursor na área de</p><p>edição do script. O local do cursor é mostrado através de uma animação com seta piscante.</p><p>2.2 Declarando Variáveis</p><p>É possível declarar variáveis implicitamente ou explicitamente.</p><p>Para declarar uma variável implicitamente, use o nome no script. Automaticamente, a variável é criada e inicializada</p><p>com o valor da atribuição ou permanece com o valor EMPTY, ou seja, vazia ou sem nenhum valor, caso não receba</p><p>nenhum valor antes de ser utilizada.</p><p>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</p><p>variável com o mesmo nome, gerando erros no script.</p><p>Para declarar variáveis explicitamente, utilize o comando Dim, como no exemplo a seguir.</p><p>Dim Temperatura</p><p>Pode-se declarar múltiplas variáveis separando cada nome de variável com uma vírgula, como no exemplo a seguir.</p><p>Dim Esquerda, Direita, Topo, Base</p><p>Em virtude de os scripts no Elipse E3 serem todos associados a um objeto em particular, as variáveis são sempre</p><p>locais, válidas apenas para o escopo do script. Para ter-se variáveis públicas ou globais, deve-se criar um Tag Interno</p><p>e utilizá-lo para armazenar o valor desejado.</p><p>https://learn.microsoft.com/pt-br/dotnet/visual-basic/language-reference/</p><p>15</p><p>Programando no Elipse E3</p><p>2.3 Obtendo Referências aos Objetos</p><p>Uma das características mais importantes ao se trabalhar com scripts dentro do Elipse E3 é considerar a separação</p><p>existente entre os processos que são executados no servidor e aqueles executados na interface do cliente (Elipse E3</p><p>Viewer). Para se trabalhar com scripts, pode-se manipular:</p><p>· Objetos do servidor através do servidor</p><p>· Objetos do servidor através do Elipse E3 Viewer</p><p>· Objetos do Viewer através do mesmo Elipse E3 Viewer</p><p>No entanto, não se pode manipular diretamente:</p><p>· Objetos do Viewer através do servidor, pois isto só é possível através da criação de eventos no Viewer, ligados a</p><p>variáveis que estão no servidor</p><p>· Objetos de um Viewer a partir de outro Viewer, pois isto só é possível através da criação de eventos ligados a</p><p>variáveis que estão no servidor</p><p>Tais limitações são decorrentes do fato de que, por definição, existe uma independência entre o que cada uma das</p><p>estações Elipse E3 Viewer está executando ou visualizando e o servidor, e vice-versa. Por isto, todas as atividades,</p><p>tanto do servidor como do Elipse E3 Viewer, necessitam ser coordenadas de forma assíncrona ou através de eventos</p><p>para operarem de forma harmoniosa.</p><p>Logo, devido a esta independência ao se criar um script, primeiro deve-se obter uma referência correta dos objetos</p><p>que se deseja manipular, ou seja, é necessário que o objeto seja primeiramente encontrado nos vários módulos do</p><p>Elipse E3.</p><p>Vale repetir que, ao se editar um script, o usuário pode utilizar o AppBrowser, que permite copiar para o script o</p><p>caminho de um método ou propriedade de forma completa, auxiliando-o na criação de scripts.</p><p>Portanto, para acessar os objetos externos que estão sendo manipulados em um script, são utilizadas algumas</p><p>diretivas básicas. Por exemplo, para se manipular o valor de um Tag de Comunicação, o caminho é Servidor - Driver -</p><p>Pasta (se houver) - Tag. Já se o objetivo é manipular um botão em uma Tela, o caminho é Viewer - Quadro (se</p><p>houver) - Tela - Botão.</p><p>As localizações de origem de scripts, do ponto de vista da metodologia para acesso dos objetos, são as seguintes:</p><p>· Servidor</p><p>· Telas e Quadros (Elipse E3 Viewer)</p><p>· ElipseX (bibliotecas): podem ser XFolders, XObjects, que executam no servidor, ou XControls, que executam no</p><p>Elipse E3 Viewer</p><p>2.3.1 Acessando Propriedades do Servidor</p><p>Para se acessar um objeto em execução no servidor a partir de um objeto de Tela ou um ElipseX, deve-se usar o</p><p>método Application.GetObject.</p><p>A palavra Application</p><p>ao</p><p>eixo vertical, independente da configuração da propriedade FlipVertical, comum a todos os objetos de Tela. O valor</p><p>padrão desta propriedade é Falso.</p><p>NOTAS</p><p>· Esta propriedade só tem efeito se o objeto Figura não foi convertido para símbolo, ou seja, se a propriedade</p><p>Convert está configurada para o valor 0 (zero).</p><p>· Para objetos criados em versões anteriores à implementação desta propriedade e abertos em aplicações a partir</p><p>da versão 6.7, o valor desta propriedade é configurado para Verdadeiro.</p><p>4.3.2.11.2.10 OverrideFillColor</p><p>Quando a propriedade OverrideFillMode é configurada com os valores 2 (dois) ou 3 (três), esta propriedade é</p><p>usada para definir a cor a ser usada no preenchimento da imagem, ao invés da cor original. Nos scripts, utilize o</p><p>método RGB do VBScript para montar a cor a ser associada a esta propriedade. O valor padrão desta propriedade é</p><p>vermelho (RGB(255, 0, 0)). O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub DrawPicture1_Click()</p><p>' Ao clicar no objeto seta o modo</p><p>' Override para sólido e troca a cor de</p><p>' preenchimento da imagem para azul</p><p>OverrideFillMode = 2</p><p>OverrideFillColor = RGB(0, 0, 255)</p><p>End Sub</p><p>NOTA</p><p>Esta propriedade só tem efeito quando o objeto Figura trabalha com arquivos Metafile (WMF ou EMF).</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>Visualização</p><p>128</p><p>4.3.2.11.2.11 OverrideFillMode</p><p>Esta propriedade especifica o modo do preenchimento da imagem do objeto, quando este está mostrando um</p><p>arquivo Windows Metafile e altera o modo original de preenchimento da imagem sem alterar o arquivo definido pela</p><p>propriedade Filename. A tabela a seguir contém os valores válidos para esta propriedade.</p><p>Opções disponíveis para a propriedade OverrideFillMode</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - NoOverride A imagem mantém o preenchimento original (padrão)</p><p>1 - Wireframe A imagem não é preenchida</p><p>2 - SolidFill A imagem é preenchida com a cor especificada pela</p><p>propriedade OverrideFillColor</p><p>3 - ByBrightness A imagem é preenchida com a cor especificada pela</p><p>propriedade OverrideFillColor, porém leva em conta</p><p>qual era a intensidade da cor original da imagem</p><p>O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub DrawPicture1_Click()</p><p>' Ao clicar no objeto seta o modo</p><p>' Override para sólido e troca a cor de</p><p>' preenchimento da imagem para azul</p><p>OverrideFillMode = 2</p><p>OverrideFillColor = RGB(0, 0, 255)</p><p>End Sub</p><p>NOTA</p><p>Esta propriedade só tem efeito quando o objeto Figura trabalha com arquivos Metafile (WMF ou EMF).</p><p>4.3.2.11.2.12 OverrideLineColor</p><p>Quando a propriedade EnableOverrideLineColor está configurada para Verdadeiro, esta propriedade é usada</p><p>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</p><p>VBScript para montar a cor a ser associada a esta propriedade. O valor padrão desta propriedade é vermelho</p><p>(RGB(255, 0, 0)). O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub DrawPicture1_Click()</p><p>OverrideLineColor = RGB(0, 0, 255)</p><p>End Sub</p><p>NOTA</p><p>Esta propriedade só tem efeito quando o objeto Figura trabalha com arquivos Metafile (WMF ou EMF).</p><p>4.3.2.11.2.13 Shadow</p><p>Indica a presença do efeito de sombra no objeto. Se configurada para Verdadeiro, o objeto possui uma sombra,</p><p>cujas coordenadas são estabelecidas pelas propriedades ShadowX e ShadowY. Do contrário, o objeto não possui o</p><p>efeito de sombra. O valor padrão desta propriedade é Falso.</p><p>4.3.2.11.2.14 ShadowColor</p><p>Especifica a cor do preenchimento da sombra do objeto. Esta cor é utilizada quando a propriedade Shadow está</p><p>configurada para Verdadeiro. Nos scripts, utilize o método RGB do VBScript para montar a cor a ser associada a esta</p><p>propriedade. O valor padrão desta propriedade é cinza escuro (RGB(128, 128, 128)). O script a seguir contém um</p><p>exemplo de uso desta propriedade.</p><p>Sub Botao1_Click()</p><p>' Troca a cor de fundo do botao para cinza claro</p><p>' quando se clica no objeto</p><p>ShadowColor = RGB(192, 192, 192)</p><p>End Sub</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>129</p><p>Visualização</p><p>NOTA</p><p>Esta propriedade só tem efeito quando o objeto Figura trabalha com arquivos Metafile (WMF ou EMF).</p><p>4.3.2.11.2.15 ShadowX</p><p>Define a coordenada vertical à esquerda da sombra deste objeto, em unidades Himetric. Esta sombra é sempre</p><p>relativa à propriedade X do objeto. Valores positivos indicam que a sombra está à direita do objeto, e negativos à</p><p>esquerda. O valor padrão desta propriedade é 200.</p><p>4.3.2.11.2.16 ShadowY</p><p>Define a coordenada horizontal superior da sombra deste objeto, em unidades Himetric. Esta sombra é sempre</p><p>relativa a propriedade Y do objeto. Valores positivos indicam que a sombra está abaixo do objeto, e negativos acima.</p><p>O valor padrão desta propriedade é 200. O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub Botao1_Click()</p><p>ShadowY = 250</p><p>End Sub</p><p>NOTA</p><p>Esta propriedade só tem efeito quando o objeto Figura trabalha com arquivos Metafile (WMF ou EMF).</p><p>4.3.2.11.2.17 TransparentColor</p><p>Quando a propriedade TransparentMode está configurada para 1 (um), esta propriedade define qual cor da</p><p>imagem não é desenhada, e a imagem permanece transparente nestes pontos. Nos scripts, utilize o método RGB do</p><p>VBScript para montar a cor a ser associada a esta propriedade. O valor padrão desta propriedade é branco</p><p>(RGB(255, 255, 255)). O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub DrawPicture1_Click()</p><p>' Deixa a cor da imagem azul transparente</p><p>' quando se clica no objeto Figura</p><p>TransparentMode = 1 ' ByColor</p><p>TransparentColor = RGB(0, 0, 255)</p><p>End Sub</p><p>4.3.2.11.2.18 TransparentMode</p><p>Esta propriedade especifica o modo como é o efeito de transparência na imagem. A tabela a seguir contém os</p><p>valores possíveis para esta propriedade.</p><p>Opções disponíveis para a propriedade TransparentMode</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - Disabled Nenhuma transparência é efetuada (padrão)</p><p>1 - ByColor A transparência é de acordo com a cor definida na</p><p>propriedade TransparentColor</p><p>2 - ByPercent A imagem permanece translúcida com porcentagem de</p><p>transparência especificada na propriedade</p><p>TransparentPercent</p><p>O script a seguir contém um exemplo de uso desta propriedade.</p><p>Sub DrawPicture1_Click()</p><p>' Deixa a cor da imagem azul transparente</p><p>' quando se clica no objeto Figura</p><p>TransparentMode = 1 ' ByColor</p><p>TransparentColor = RGB(0, 0, 255)</p><p>End Sub</p><p>4.3.2.11.2.19 TransparentPercent</p><p>Quando a propriedade TransparentMode está configurada para 2 (dois), esta propriedade define quão translúcida</p><p>a imagem é exibida, variando de 0 (zero, totalmente translúcida) a 100 (opaca ou sólida). O script a seguir contém um</p><p>exemplo de uso desta propriedade.</p><p>Sub DrawPicture1_Click()</p><p>' Deixa a imagem translúcida quando se clica no objeto</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>Visualização</p><p>130</p><p>TransparentMode = 1 ' ByPercent</p><p>TransparentPercent = 50 ' 50% translúcido</p><p>End Sub</p><p>4.3.2.11.2.20 VerticalFillStyle</p><p>Define como é o preenchimento vertical do objeto. Esta propriedade trabalha em conjunto com a propriedade</p><p>VerticalPercentFill, que informa qual porcentagem do objeto deve ser preenchida. Estas duas propriedades</p><p>permitem uma simulação de um preenchimento de nível em um objeto.</p><p>Opções disponíveis para a propriedade VerticalFillStyle</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - FillBottomToTop A porcentagem de preenchimento é de baixo para cima</p><p>(padrão)</p><p>1 - FillTopToBottom A porcentagem de preenchimento é de cima para baixo</p><p>2 - FillCenterToEdgesV A porcentagem de preenchimento é do centro para as</p><p>bordas</p><p>4.3.2.11.2.21 VerticalPercentFill</p><p>Utilize esta propriedade para especificar qual a porcentagem da área vertical do objeto deve ser preenchida. Os</p><p>valores aceitos por esta propriedade variam de 0 (zero) a 100. Esta propriedade trabalha em conjunto com a</p><p>propriedade VerticalFillStyle, que informa como este preenchimento ocorre. O valor padrão desta propriedade é</p><p>100.</p><p>4.3.2.12 Fonte</p><p>Esta seção contém informações sobre propriedades do objeto Fonte (Font) retornado pelas propriedades que</p><p>configuram uma fonte para os textos dos objetos de Tela, exceto os MS Forms. Este objeto não possui eventos nem</p><p>métodos associados.</p><p>4.3.2.12.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Fonte (Font) retornado pelas propriedades que</p><p>configuram uma fonte para os textos dos objetos de Tela, exceto os MS Forms.</p><p>4.3.2.12.1.1 Bold</p><p>Esta propriedade indica se o texto do objeto de Tela está em negrito.</p><p>4.3.2.12.1.2 Charset</p><p>Esta propriedade indica o conjunto de caracteres disponível para a fonte do objeto de Tela. Os valores possíveis</p><p>para esta propriedade estão descritos na tabela a seguir.</p><p>Valores disponíveis para a propriedade Charset</p><p>VALOR PÁGINA DE CÓDIGO NOME DESCRIÇÃO</p><p>0 1252 ANSI_CHARSET ANSI (American National</p><p>Standards Institute)</p><p>1 -- DEFAULT_CHARSET Padrão (mostra o conjunto</p><p>de caracteres disponível na</p><p>Fonte)</p><p>2 -- SYMBOL_CHARSET Símbolos</p><p>128 932 SHIFTJIS_CHARSET Japonês (Shift-JIS)</p><p>129 949 HANGUL_CHARSET Coreano</p><p>134 936 GB2312_CHARSET Chinês Simplificado (GBK)</p><p>136 950 CHINESEBIG5_CHARSET Chinês Tradicional (Big5)</p><p>161 1253 GREEK_CHARSET Grego</p><p>162 1254 TURKISH_CHARSET Turco</p><p>131</p><p>Visualização</p><p>VALOR PÁGINA DE CÓDIGO NOME DESCRIÇÃO</p><p>177 1255 HEBREW_CHARSET Hebraico</p><p>178 1256 ARABIC_CHARSET Árabe</p><p>186 1257 BALTIC_CHARSET Báltico</p><p>204 1251 RUSSIAN_CHARSET Cirílico</p><p>222 874 THAI_CHARSET Tailandês</p><p>238 1250 EE_CHARSET Centro-Europeu</p><p>255 -- OEM_CHARSET OEM (Original Equipment</p><p>Manufacturer)</p><p>4.3.2.12.1.3 Italic</p><p>Esta propriedade indica se o texto do objeto de Tela está em itálico.</p><p>4.3.2.12.1.4 Name</p><p>Esta propriedade indica o nome da fonte do objeto de Tela.</p><p>4.3.2.12.1.5 Size</p><p>Esta propriedade indica o tamanho, em pontos, da fonte do texto do objeto de Tela.</p><p>4.3.2.12.1.6 Strikethrough</p><p>Esta propriedade indica se o texto do objeto de Tela usa o efeito de tachado.</p><p>4.3.2.12.1.7 Underline</p><p>Esta propriedade indica se o texto do objeto de Tela usa o efeito de sublinhado.</p><p>4.3.2.12.1.8 Weight</p><p>Esta propriedade indica a variação do efeito de negrito na fonte do objeto de Tela, ou seja, da propriedade Bold.</p><p>Os valores para esta propriedade podem variar entre 0 (zero, não interfere no efeito de negrito) e 1000.</p><p>4.3.2.13 Grupo</p><p>Esta seção contém informações sobre propriedades do Grupo de objetos (DrawGroup). Este objeto não possui</p><p>eventos nem métodos associados.</p><p>4.3.2.13.1 Propriedades</p><p>Esta seção contém informações sobre propriedades do Grupo de objetos (DrawGroup).</p><p>4.3.2.13.1.1 EnableOverrideLineColor</p><p>Esta propriedade habilita ou desabilita o objeto Grupo a sobrescrever as cores originais das linhas dos objetos</p><p>contidos no Grupo. Se esta propriedade está habilitada, as cores originais das linhas dos objetos do Grupo são</p><p>substituídas pela cor definida na propriedade OverrideLineColor. Caso contrário, cada objeto contido no Grupo</p><p>apresenta a cor de linha original. O valor padrão desta propriedade é Falso.</p><p>4.3.2.13.1.2 OverrideFillColor</p><p>Quando a propriedade OverrideFillMode está configurada para 2 (dois) ou 3 (três), esta propriedade é usada para</p><p>definir a cor a ser usada no preenchimento dos objetos contíguos no Grupo, ao invés da cor original. Nos scripts,</p><p>utilize o método RGB do VBScript para montar a cor a ser associada a esta propriedade. O valor padrão desta</p><p>propriedade é vermelho (RGB(255, 0, 0)).</p><p>4.3.2.13.1.3 OverrideFillMode</p><p>Esta propriedade especifica o modo do preenchimento dos objetos que estão dentro do Grupo e altera o modo</p><p>original de preenchimento da imagem, sem alterar a configuração original de preenchimento dos objetos.</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>Visualização</p><p>132</p><p>Opções disponíveis para a propriedade OverrideFillMode</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - NoOverride Preenchimento original do objeto (padrão)</p><p>1 - Wireframe Os objetos não são preenchidos, desenham somente as</p><p>bordas</p><p>2 - SolidFill O preenchimento dos objetos contidos no Grupo é</p><p>sólido com a cor especificada na propriedade</p><p>OverrideFillColor</p><p>3 - ByBrightness O preenchimento dos objetos contidos no Grupo é</p><p>sólido com a cor especificada pela propriedade</p><p>OverrideFillColor, porém leva em conta qual era a</p><p>intensidade da cor original de preenchimento de cada</p><p>objeto</p><p>4.3.2.13.1.4 OverrideLineColor</p><p>Quando a propriedade EnableOverrideLineColor está configurada para Verdadeiro, esta propriedade é usada</p><p>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</p><p>método RGB do VBScript para montar a cor a ser associada a esta propriedade. O valor padrão desta propriedade é</p><p>vermelho (RGB(255, 0, 0)).</p><p>4.3.2.14 Microsoft Forms</p><p>Esta seção contém informações sobre eventos e propriedades comuns de objetos Microsoft Forms. Estes objetos</p><p>não possuem métodos comuns associados.</p><p>4.3.2.14.1 Eventos Comuns</p><p>Esta seção contém informações sobre os eventos comuns aos objetos Microsoft Forms.</p><p>4.3.2.14.1.1 BeforeDragOver</p><p>BeforeDragOver(Index, Cancel, Data, X, Y, DragState, Effect, Shift)</p><p>Ocorre quando há uma ação de arrastar e soltar (drag-and-drop) sobre um objeto. Utilize este evento para monitorar</p><p>se o ponteiro do mouse entrou, deixou ou permaneceu sobre um objeto alvo. O evento é disparado quando o</p><p>usuário move o ponteiro do mouse ou pressiona ou solta algum botão do mouse. A posição do ponteiro do mouse</p><p>indica qual objeto gerou o evento. Pode-se determinar o status do ponteiro do mouse examinando o parâmetro</p><p>DragState.</p><p>Muitos objetos não suportam operações de arrastar e soltar enquanto o parâmetro Cancel tem o valor Falso, que é o</p><p>padrão. Isto significa que o objeto rejeita qualquer tentativa de arrastar ou soltar algum outro objeto sobre si e,</p><p>consequentemente, não dispara o evento BeforeDropOrPaste. O objeto Text Box (Caixa de Texto) e o objeto Combo</p><p>(Lista de Seleção) são exceções. Estes objetos aceitam operações de arrastar e soltar mesmo quando o parâmetro</p><p>Cancel tem o valor Falso.</p><p>Parâmetros disponíveis no evento BeforeDragOver</p><p>NOME DESCRIÇÃO</p><p>Index Indica o índice da página, em um objeto multi-páginas,</p><p>que é afetada pela operação que gerou o evento. Para</p><p>outros objetos é ignorada</p><p>Cancel Status do evento. O padrão é Falso e indica que é o</p><p>objeto alvo que trata o evento e não a aplicação</p><p>principal</p><p>Data Dados sendo arrastados para o objeto alvo,</p><p>propriamente ditos</p><p>X, Y Posição do ponteiro do mouse dentro do objeto alvo,</p><p>em pontos. X é medido a partir do lado esquerdo do</p><p>objeto e Y é medido a partir do topo</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>133</p><p>Visualização</p><p>NOME DESCRIÇÃO</p><p>DragState Indica a condição do ponteiro do mouse quando este</p><p>evento é gerado. Os valores possíveis para este</p><p>parâmetro são 0 - fmDragStateEnter: O ponteiro do</p><p>mouse está dentro do alcance do objeto, 1 -</p><p>fmDragStateLeave: O ponteiro do mouse está fora do</p><p>alcance do objeto ou 2 - fmDragStateOver: O ponteiro</p><p>do mouse está em uma nova posição, mas ainda está</p><p>dentro do alcance do objeto</p><p>Effect Indica as ações que o objeto alvo suporta, ou seja, o</p><p>efeito de arrastar sobre o objeto alvo. Os valores</p><p>possíveis para este parâmetro são 0 -</p><p>fmDropEffectNone: Objeto alvo não aceita copiar ou</p><p>mover de alguma origem, 1 - fmDropEffectCopy: Objeto</p><p>alvo permite copiar de alguma origem para si, 2 -</p><p>fmDropEffectMove: Objeto alvo permite mover de</p><p>alguma origem para si ou 3 -</p><p>fmDropEffectCopyOrMove: Objeto alvo permite copiar</p><p>ou mover de alguma origem para si</p><p>Shift Inteiro cuja soma dos fatores indica o status das teclas</p><p>SHIFT, CTRL e ALT. Os valores possíveis para este</p><p>parâmetro são 1: Tecla SHIFT pressionada, 2: Tecla CTRL</p><p>pressionada ou 4: Tecla ALT pressionada. Por exemplo,</p><p>um valor igual a 5 (cinco) indica que as teclas SHIFT e ALT</p><p>estavam pressionadas (1 + 4 = 5)</p><p>4.3.2.14.1.2 BeforeDropOrPaste</p><p>BeforeDropOrPaste(Index, Cancel, Ctrl, Action, Data, X, Y, Effect, Shift)</p><p>Disparado no momento imediatamente anterior a uma operação de arrastar e soltar. Normalmente, isto ocorre logo</p><p>após o evento BeforeDragOver.</p><p>Parâmetros disponíveis no evento BeforeDropOrPaste</p><p>NOME DESCRIÇÃO</p><p>Index Indica o índice da página, em um objeto multi-páginas,</p><p>que é afetada pela operação que gerou o evento. Para</p><p>outros objetos é ignorada</p><p>Cancel Status do evento. O padrão é Falso e indica que é o</p><p>objeto alvo que trata o evento e não a aplicação</p><p>principal</p><p>Ctrl Objeto alvo</p><p>Action Indica o resultado, baseado nas configurações do</p><p>teclado, de uma operação de arrastar e soltar pendente.</p><p>Os valores possíveis para este parâmetro são 2 -</p><p>fmActionPaste: Cola o objeto selecionado no objeto</p><p>alvo ou 3 - fmActionDragDrop: Indica que o usuário</p><p>arrastou o objeto selecionado de sua origem e soltou-o</p><p>sobre o objeto alvo</p><p>Data Dados sendo arrastados para o objeto alvo,</p><p>propriamente ditos</p><p>X, Y Posição do ponteiro do mouse dentro do objeto alvo,</p><p>em pontos. X é medido a partir do lado esquerdo do</p><p>objeto e Y é medido a partir do topo</p><p>Visualização</p><p>134</p><p>NOME DESCRIÇÃO</p><p>Effect Indica as ações que o objeto alvo suporta, ou seja, o</p><p>efeito de arrastar sobre o objeto alvo. Os valores</p><p>possíveis para este parâmetro são 0 -</p><p>fmDropEffectNone: Objeto alvo não aceita copiar ou</p><p>mover de alguma origem, 1 - fmDropEffectCopy: Objeto</p><p>alvo permite copiar de alguma origem para si, 2 -</p><p>fmDropEffectMove: Objeto alvo permite mover de</p><p>alguma origem para si ou 3 -</p><p>fmDropEffectCopyOrMove: Objeto alvo permite copiar</p><p>ou mover de alguma origem para si</p><p>Shift Inteiro cuja soma dos fatores indica o status das teclas</p><p>SHIFT, CTRL e ALT. Os valores possíveis para este</p><p>parâmetro são 1: Tecla SHIFT pressionada, 2: Tecla CTRL</p><p>pressionada ou 4: Tecla ALT pressionada. Por exemplo,</p><p>um valor igual a 5 (cinco) indica que as teclas SHIFT e ALT</p><p>estavam pressionadas (1 + 4 = 5)</p><p>4.3.2.14.1.3 Change</p><p>Change()</p><p>Ocorre quando o valor da propriedade Value de um objeto é modificada. A seguir estão alguns exemplos de ações</p><p>que disparam este evento:</p><p>· Clicar em uma Caixa de Seleção, em um Botão de Opção ou em um Botão Incremento-Decremento</p><p>· Clicar ou selecionar palavras em uma Lista de Seleção ou em um Editor de Texto</p><p>· Selecionar diferentes abas em uma caixa de diálogo</p><p>· Mover a barra de rolagem em uma Barra de Rolagem</p><p>· Clicar nas setas de um Botão Incremento-Decremento</p><p>· Selecionar diferentes páginas em um objeto multi-páginas</p><p>4.3.2.14.1.4 Error</p><p>Error(Number, Description, SCode, Source, HelpFile, HelpContext, CancelDisplay)</p><p>Gerado por um erro interno em um objeto. Se este evento não é tratado, o Elipse E3 mostra uma mensagem de erro</p><p>genérica.</p><p>Parâmetros disponíveis no evento Error</p><p>NOME DESCRIÇÃO</p><p>Number Número inteiro identificador do erro</p><p>Description String com a descrição do erro</p><p>SCode Inteiro com o código de erro do subsistema OLE (não</p><p>utilizado)</p><p>Source String com o objeto que originou o erro</p><p>HelpFile String com o nome e o caminho do arquivo de ajuda</p><p>HelpContext Número inteiro de contexto do tópico de ajuda referente</p><p>ao erro</p><p>CancelDisplay Booleano que indica se o erro deve ser mostrado em</p><p>uma caixa de mensagem</p><p>4.3.2.14.1.5 KeyPress</p><p>KeyPress(KeyAscii)</p><p>Ocorre quando um objeto tem o foco de teclado e o usuário pressiona uma tecla que corresponde a um caractere</p><p>que pode ser mostrado em tela (uma tecla ANSI, de código indicado no parâmetro KeyAscii), ou seja, o evento ocorre</p><p>quando alguma das teclas a seguir são pressionadas:</p><p>135</p><p>Visualização</p><p>· Qualquer caractere do teclado que possa ser impresso</p><p>· Tecla CTRL combinada com qualquer caractere do alfabeto padrão</p><p>· Tecla CTRL combinada com qualquer caractere especial</p><p>· Tecla BACKSPACE</p><p>· Tecla ESC</p><p>Este evento não ocorre nas seguintes condições:</p><p>· Pressionando a tecla TAB</p><p>· Pressionando a tecla ENTER</p><p>· Pressionando a tecla DEL (esta tecla não é padrão ANSI)</p><p>· Pressionando as setas do teclado</p><p>· Quando uma tecla move o foco de um objeto para outro</p><p>Enquanto o usuário pressiona uma tecla que produz um código ANSI, o objeto recebe o evento KeyDown e este</p><p>evento repetidamente. Quando o usuário libera a tecla, o evento KeyUp ocorre. Para monitorar o estado físico do</p><p>teclado ou manipular teclas não reconhecidas por este evento (como teclas de função, navegação, etc.), utilize os</p><p>eventos KeyDown e KeyUp.</p><p>NOTA</p><p>Para uma lista com todos os códigos de tecla disponíveis para o parâmetro KeyAscii, consulte o artigo Keys</p><p>Enumeration no Microsoft Developer Network.</p><p>4.3.2.14.2 Propriedades Comuns</p><p>Esta seção contém informações sobre as propriedades comuns aos objetos Microsoft Forms.</p><p>NOTA</p><p>O Elipse E3 utiliza para definição de coordenadas e espessura o sistema Himetric. Neste sistema, cada unidade</p><p>lógica equivale a um milésimo de centímetro, ou seja, cada 1000 unidades equivalem a um centímetro. Assim, este é</p><p>o padrão adotado na descrição das propriedades do Elipse E3, quando aplicável.</p><p>4.3.2.14.2.1 BackColor</p><p>Determina a cor de fundo de um objeto. Nos scripts, utilize o método RGB do VBScript para montar a cor a ser</p><p>associada a esta propriedade. O valor padrão desta propriedade para os objetos Lista de Seleção, Lista e Editor de</p><p>Texto é a cor branca (RGB(255, 255, 255)), e para os demais objetos é a cor bege (RGB(236, 233, 216)).</p><p>4.3.2.14.2.2 ForeColor</p><p>Especifica a cor do preenchimento do fundo de um objeto. Nos scripts, utilize o método RGB do VBScript para</p><p>montar a cor a ser associada a esta propriedade. O valor padrão desta propriedade para todos os objetos Microsoft</p><p>Forms é a cor preta (RGB(0, 0, 0)).</p><p>4.3.2.14.2.3 MouseIcon</p><p>Esta propriedade atribui uma imagem ao ponteiro do mouse quando este é movido sobre um objeto. Esta</p><p>propriedade é válida somente quando a propriedade MousePointer está definida como 99 -</p><p>fmMousePointerCustom.</p><p>Um arquivo com imagem pode ser selecionado para o ponteiro do mouse através da Lista de Propriedades</p><p>(extensões .cur ou .ico) ou via scripts, utilizando-se a função LoadPicture para especificar o caminho e o nome do</p><p>arquivo que contém o ícone personalizado (somente arquivos com a extensão .cur). O script a seguir contém um</p><p>exemplo de uso desta propriedade.</p><p>Sub CommandButton1_Click()</p><p>' Atribuindo o item 99 - fmMousePointerCustom à propriedade</p><p>' para que ela aceite a personalização do ícone do mouse</p><p>Screen.Item("CheckBox1").MousePointer = 99</p><p>Screen.Item("CheckBox1").MouseIcon = LoadPicture("c:\a.cur")</p><p>End Sub</p><p>https://msdn.microsoft.com/en-us/library/system.windows.forms.keys(VS.71).aspx</p><p>https://msdn.microsoft.com/en-us/library/system.windows.forms.keys(VS.71).aspx</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/rgb-function</p><p>https://learn.microsoft.com/pt-br/office/vba/api/access.application.loadpicture</p><p>Visualização</p><p>136</p><p>4.3.2.14.2.4 MousePointer</p><p>Esta propriedade especifica o tipo de ponteiro do mouse que é mostrado quando o usuário o posiciona sobre um</p><p>objeto. As opções disponíveis para esta propriedade estão descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade MousePointer</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - fmMousePointerDefault Ponteiro padrão (a imagem é determinada pelo objeto)</p><p>1 - fmMousePointerArrow Seta</p><p>2 - fmMousePointerCross Ponteiro em forma de cruz</p><p>3 - fmMousePointerIBeam Em forma de I</p><p>6 - fmMousePointerSizeNESW Seta dupla apontando para nordeste e sudoeste</p><p>7 - fmMousePointerSizeNS Seta dupla apontando para norte e sul</p><p>8 - fmMousePointerNWSE Seta dupla apontando para noroeste e sudeste</p><p>9 - fmMousePointerWE Seta dupla apontando para oeste e leste</p><p>10 - fmMousePointerUpArrow Seta para cima</p><p>11 - fmMousePointerHourglass Ampulheta</p><p>12 - fmMousePointerNoDrop Símbolo de Not (círculo com uma linha diagonal) na</p><p>parte superior do objeto sendo arrastado (indica um</p><p>destino inválido para uma operação de soltar)</p><p>13 - fmMousePointerAppStarting Seta com uma ampulheta</p><p>14 - fmMousePointerHelp Seta com um ponto de interrogação</p><p>15 - fmMousePointerSizeAll Dimensiona todo o cursor (setas apontando para norte,</p><p>sul, leste e oeste)</p><p>99 - fmMousePointerCustom Usa o ícone especificado pela propriedade MouseIcon</p><p>Use esta propriedade para indicar alterações de funcionalidade conforme o ponteiro do mouse passa sobre os</p><p>objetos em uma Tela. Por exemplo, a configuração de ampulheta (opção 11 - fmMousePointerHourglass) é útil para</p><p>indicar que o usuário precisa esperar algum tempo para que um processo ou operação seja finalizado. Alguns ícones</p><p>podem variar, dependendo das configurações do sistema, como os ícones associados aos temas da área de trabalho.</p><p>O valor padrão desta propriedade é 0 - fmMousePointerDefault.</p><p>4.3.2.14.3 Barra de Rolagem</p><p>Esta seção contém informações sobre eventos e propriedades do objeto Barra de Rolagem (Scrollbar). Este objeto</p><p>não possui métodos associados.</p><p>4.3.2.14.3.1 Eventos</p><p>Esta seção contém informações sobre os eventos do objeto Barra de Rolagem (Scrollbar).</p><p>Scroll</p><p>Scroll()</p><p>Gerado quando o ponteiro da barra de rolagem é movido para alguma direção.</p><p>4.3.2.14.3.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Barra de Rolagem (Scrollbar).</p><p>Delay</p><p>Especifica um tempo de espera para o objeto. Esta propriedade afeta a duração de tempo entre eventos Change</p><p>consecutivos, gerados quando o usuário clica e mantém pressionada a Barra de Rolagem. O primeiro evento ocorre</p><p>imediatamente. O tempo de espera até a segunda ocorrência do evento é de 5 (cinco) vezes o valor especificado</p><p>nesta propriedade. Após o tempo inicial, o intervalo entre os eventos é o valor especificado para esta propriedade. O</p><p>137</p><p>Visualização</p><p>valor padrão desta propriedade é 50ms. Isto significa que o objeto inicia o primeiro evento depois de 250 ms, ou 5</p><p>(cinco) vezes o valor especificado, e inicia cada evento subsequente depois de 50 ms.</p><p>LargeChange</p><p>Especifica a quantidade de passos do cursor da Barra de Rolagem. O valor desta propriedade é a quantidade pela</p><p>qual a propriedade Value é alterada, quando o usuário clica na área entre a caixa de rolagem e o cursor da Barra de</p><p>Rolagem. Qualquer valor inteiro é permitido para esta propriedade, mas o intervalo recomendado é de -32,767 a</p><p>+32,767, e este valor deve estar entre os valores determinados nas propriedade Max e Min da Barra de Rolagem.</p><p>Max</p><p>Esta propriedade é utilizada para determinar o limite máximo do objeto.</p><p>Min</p><p>Esta propriedade é utilizada para determinar o limite mínimo do objeto.</p><p>Orientation</p><p>Esta propriedade é utilizada para determinar a orientação do objeto na Tela. Os valores possíveis para esta</p><p>propriedade são -1 - fmOrientationAuto: Determina automaticamente a orientação com base nas dimensões do</p><p>objeto, isto é, conforme foi criado (padrão), 0 - fmOrientationVertical: O objeto é disposto verticalmente ou 1 -</p><p>fmOrientationHorizontal: O objeto é disposto horizontalmente.</p><p>ProportionalThumb</p><p>Esta propriedade especifica se o tamanho da caixa de rolagem é igual à dimensão do objeto. Se esta propriedade</p><p>está configurada para Verdadeiro, a caixa da Barra de Rolagem tem a mesma dimensão do objeto. Caso contrário, se</p><p>o objeto é dimensionado, a caixa de rolagem permanece com o tamanho original. O valor padrão desta propriedade</p><p>é Verdadeiro.</p><p>SmallChange</p><p>Esta propriedade especifica a quantidade de movimento que ocorre quando o usuário clica em uma seta de</p><p>rolagem no objeto. O valor padrão desta propriedade é 1 (um).</p><p>Value</p><p>Um número inteiro entre os valores definidos pelas propriedades Min e Max. Indica a posição inicial da barra de</p><p>rolagem. Não aceita valores menores que o valor da propriedade Min nem maiores que o valor da propriedade Max.</p><p>4.3.2.14.4 Botão de Comando</p><p>Esta seção contém informações sobre eventos e propriedades do objeto Botão de Comando (CommandButton). Este</p><p>objeto não possui métodos associados.</p><p>4.3.2.14.4.1 Eventos</p><p>Esta seção contém informações sobre os eventos do objeto Botão de Comando (CommandButton).</p><p>MouseMove</p><p>MouseMove()</p><p>Ocorre quando o ponteiro do mouse é movimentado sobre o botão de comando.</p><p>4.3.2.14.4.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Botão de Comando (CommandButton).</p><p>Accelerator</p><p>Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora é uma tecla que, usada em conjunto com a</p><p>tecla ALT, move o foco para o objeto. O valor padrão desta propriedade é uma String vazia.</p><p>AutoSize</p><p>Esta propriedade ajusta a largura do texto, caso a área disponível ultrapasse o tamanho do objeto. Para o objeto</p><p>Botão de Comando (Command Button), quando esta propriedade está configurada para Verdadeiro, a largura do</p><p>texto é reajustada para a mesma largura do objeto. O conteúdo do texto é cortado quando excede a área do objeto.</p><p>BackStyle</p><p>Esta propriedade define o estilo do plano de fundo para os objetos. Os valores possíveis para esta propriedade</p><p>são 0 - fmBackStyleTransparent: Define o objeto como transparente, isto é, nenhum fundo deste objeto é desenhado</p><p>ou 1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é desenhado (padrão).</p><p>Visualização</p><p>138</p><p>NOTA</p><p>Esta propriedade não afeta a transparência de bitmaps. Deve-se usar um editor de imagens como o Paintbrush, por</p><p>exemplo, para tornar um bitmap transparente. Nem todos os objetos ActiveX suportam bitmaps transparentes.</p><p>Caption</p><p>Define o texto que é mostrado no objeto.</p><p>Font</p><p>Esta propriedade é utilizada para determinar a fonte do objeto Botão de Comando. Esta propriedade não pode ser</p><p>utilizada em Associações e contém as subpropriedades descritas no tópico Fonte.</p><p>Locked</p><p>Esta propriedade habilita ou desabilita a edição do objeto. Se esta propriedade está configurada para Verdadeiro,</p><p>a edição não é permitida. Caso contrário, é possível editar o objeto. Os valores configurados na propriedade Enabled</p><p>influenciam o comportamento desta propriedade. Para mais detalhes, consulte a propriedade Enabled. O valor</p><p>padrão desta propriedade é Falso.</p><p>Picture</p><p>Esta propriedade especifica a figura (bitmap) atribuída ao objeto. Um arquivo com imagem pode ser selecionado</p><p>através da Lista de Propriedades ou via scripts, utilizando-se a função LoadPicture para especificar o caminho e o</p><p>nome do arquivo que contém a figura. Para remover a figura, clique no valor desta propriedade e pressione a tecla</p><p>DEL. A tecla BACKSPACE</p><p>(tecla de espaço do teclado) não remove a figura.</p><p>PicturePosition</p><p>Esta propriedade especifica a posição da figura atribuída ao objeto em relação a sua legenda. As opções</p><p>disponíveis para esta propriedade estão descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade PicturePosition</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - fmPicturePositionLeftTop A figura aparece à esquerda da legenda. A legenda é</p><p>alinhada com a parte superior da figura</p><p>1 - fmPicturePositionLeftCenter A figura aparece à esquerda da legenda. A legenda é</p><p>centralizada relativamente à imagem</p><p>2 - fmPicturePositionLeftBottom A figura aparece à esquerda da legenda. A legenda é</p><p>alinhada com a parte inferior da figura</p><p>3 - fmPicturePositionRightTop A figura aparece à direita da legenda. A legenda é</p><p>alinhada com a parte superior da figura</p><p>4 - fmPicturePositionRightCenter A figura aparece à direita da legenda. A legenda é</p><p>centralizada relativamente à figura</p><p>5 - fmPicturePositionRightBottom A figura aparece à direita da legenda. A legenda é</p><p>alinhada com a parte inferior da figura</p><p>6 - fmPicturePositionAboveLeft A figura aparece acima da legenda. A legenda é alinhada</p><p>com a extremidade esquerda da figura</p><p>7 - fmPicturePositionAboveCenter A figura aparece acima da legenda. A legenda é</p><p>centralizada abaixo da figura (padrão)</p><p>8 - fmPicturePositionAboveRight A figura aparece acima da legenda. A legenda é alinhada</p><p>com a extremidade direita da figura</p><p>9 - fmPicturePositionBelowLeft A figura aparece abaixo da legenda. A legenda é</p><p>alinhada com a extremidade esquerda da figura</p><p>10 - fmPicturePositionBelowCenter A figura aparece abaixo da legenda. A legenda é</p><p>centralizada acima da figura</p><p>11 - fmPicturePositionBelowRight A figura aparece abaixo da legenda. A legenda é</p><p>alinhada com a extremidade direita da figura</p><p>12 - fmPicturePositionCenter A figura aparece no centro do controle. A legenda é</p><p>centralizada horizontalmente e verticalmente sobre a</p><p>figura</p><p>https://learn.microsoft.com/pt-br/office/vba/api/access.application.loadpicture</p><p>139</p><p>Visualização</p><p>TakeFocusOnClick</p><p>Especifica se o objeto recebe o foco quando clicado. Se esta propriedade está configurada para Verdadeiro, o</p><p>objeto recebe o foco quando clicado. Caso contrário, o objeto não recebe o foco.</p><p>WordWrap</p><p>Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para o texto ultrapasse os limites</p><p>determinados no objeto.</p><p>4.3.2.14.5 Botão de Opção</p><p>Esta seção contém informações sobre propriedades do objeto Botão de Opção (MdcOptionButton). Este objeto não</p><p>possui eventos nem métodos associados.</p><p>4.3.2.14.5.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Botão de Opção (MdcOptionButton).</p><p>Accelerator</p><p>Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora é uma tecla que, usada em conjunto com a</p><p>tecla ALT, move o foco para o objeto. O valor padrão desta propriedade é uma String vazia.</p><p>Alignment</p><p>Esta propriedade especifica a posição do objeto relativa à legenda. Os valores possíveis para esta propriedade</p><p>são 0 - fmAlignmentLeft: Coloca a legenda à esquerda do objeto ou 1 - fmAligmentRight: Coloca a legenda à</p><p>direita do objeto (padrão).</p><p>AutoSize</p><p>Esta propriedade ajusta a largura do texto, caso a área disponível ultrapasse o tamanho do objeto. Quando esta</p><p>propriedade está configurada para Verdadeiro, o texto é redimensionado para coincidir com o tamanho atual do</p><p>objeto.</p><p>BackStyle</p><p>Esta propriedade define o estilo do plano de fundo para os objetos. Os valores possíveis para esta propriedade</p><p>são 0 - fmBackStyleTransparent: Define o objeto como transparente, isto é, nenhum fundo deste objeto é</p><p>desenhado, ou 1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é desenhado (padrão).</p><p>NOTA</p><p>Esta propriedade não afeta a transparência de bitmaps. Deve-se usar um editor de imagens como o Paintbrush, por</p><p>exemplo, para tornar um bitmap transparente. Nem todos os objetos ActiveX suportam bitmaps transparentes.</p><p>Caption</p><p>Define o texto que é mostrado no objeto.</p><p>Font</p><p>Esta propriedade é utilizada para determinar a fonte do objeto Botão de Opção. Esta propriedade não pode ser</p><p>utilizada em Associações e contém as subpropriedades descritas no tópico Fonte.</p><p>GroupName</p><p>Esta propriedade é utilizada para criar um grupo de objetos mutuamente exclusivos.</p><p>NOTA</p><p>Esta propriedade não é utilizada no Elipse E3 e foi mantida por motivos de compatibilidade com a especificação</p><p>padrão dos objetos Microsoft Forms.</p><p>Locked</p><p>Esta propriedade habilita ou desabilita a edição do objeto. Se esta propriedade está configurada para Verdadeiro,</p><p>a edição não é permitida. Caso contrário, é possível editar o objeto. Os valores configurados na propriedade Enabled</p><p>influenciam o comportamento desta propriedade. Para mais detalhes, consulte a propriedade Enabled. O valor</p><p>padrão desta propriedade é Falso.</p><p>Picture</p><p>Esta propriedade especifica a figura (bitmap) atribuída ao objeto. Um arquivo com imagem pode ser selecionado</p><p>através da Lista de Propriedades ou via scripts, utilizando-se a função LoadPicture para especificar o caminho e o</p><p>https://learn.microsoft.com/pt-br/office/vba/api/access.application.loadpicture</p><p>Visualização</p><p>140</p><p>nome do arquivo que contém a figura. Para remover a figura, clique no valor desta propriedade e pressione a tecla</p><p>DEL. A tecla BACKSPACE (tecla de espaço do teclado) não remove a figura. O script a seguir contém um exemplo de</p><p>uso desta propriedade.</p><p>Sub CommandButton1_Click()</p><p>Screen.Item("OptionButton1").Picture = LoadPicture("C:\aba.gif")</p><p>End Sub</p><p>PicturePosition</p><p>Esta propriedade especifica a posição da figura atribuída ao objeto em relação a sua legenda. As opções</p><p>disponíveis para esta propriedades estão descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade PicturePosition</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - fmPicturePositionLeftTop A figura aparece à esquerda da legenda. A legenda é</p><p>alinhada com a parte superior da figura</p><p>1 - fmPicturePositionLeftCenter A figura aparece à esquerda da legenda. A legenda é</p><p>centralizada relativamente à imagem</p><p>2 - fmPicturePositionLeftBottom A figura aparece à esquerda da legenda. A legenda é</p><p>alinhada com a parte inferior da figura</p><p>3 - fmPicturePositionRightTop A figura aparece à direita da legenda. A legenda é</p><p>alinhada com a parte superior da figura</p><p>4 - fmPicturePositionRightCenter A figura aparece à direita da legenda. A legenda é</p><p>centralizada relativamente à figura</p><p>5 - fmPicturePositionRightBottom A figura aparece à direita da legenda. A legenda é</p><p>alinhada com a parte inferior da figura</p><p>6 - fmPicturePositionAboveLeft A figura aparece acima da legenda. A legenda é alinhada</p><p>com a extremidade esquerda da figura</p><p>7 - fmPicturePositionAboveCenter A figura aparece acima da legenda. A legenda é</p><p>centralizada abaixo da figura (padrão)</p><p>8 - fmPicturePositionAboveRight A figura aparece acima da legenda. A legenda é alinhada</p><p>com a extremidade direita da figura</p><p>9 - fmPicturePositionBelowLeft A figura aparece abaixo da legenda. A legenda é</p><p>alinhada com a extremidade esquerda da figura</p><p>10 - fmPicturePositionBelowCenter A figura aparece abaixo da legenda. A legenda é</p><p>centralizada acima da figura</p><p>11 - fmPicturePositionBelowRight A figura aparece abaixo da legenda. A legenda é</p><p>alinhada com a extremidade direita da figura</p><p>12 - fmPicturePositionCenter A figura aparece no centro do controle. A legenda é</p><p>centralizada horizontalmente e verticalmente sobre a</p><p>figura</p><p>SpecialEffect</p><p>Esta propriedade especifica a aparência de um objeto. As opções disponíveis para esta propriedade estão</p><p>descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade SpecialEffect</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - fmButtonEffectFlat O objeto aparece plano e possui um destaque na</p><p>borda,</p><p>uma alteração de cor ou ambos</p><p>2 - fmButtonEffectSunken O objeto possui uma sombra na parte superior esquerda</p><p>e um destaque na parte inferior direita, como se</p><p>estivesse afundado na Tela (padrão)</p><p>TextAlign</p><p>Especifica como o texto é alinhado neste objeto. Os valores possíveis para esta propriedade são 1 -</p><p>fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto (padrão), 2 - fmTextAlignCenter: Alinha o</p><p>texto com o centro do objeto ou 3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto.</p><p>141</p><p>Visualização</p><p>TripleState</p><p>Esta propriedade determina até 3 (três) estados de valores para o objeto. Se esta propriedade está configurada</p><p>para Verdadeiro, o usuário pode selecionar entre as opções de estados Falso, Verdadeiro ou Nulo. O valor Nulo é</p><p>exibido como um botão sombreado. Caso contrário, o usuário pode selecionar entre os valores Falso ou Verdadeiro.</p><p>O valor padrão desta propriedade é Falso.</p><p>Value</p><p>Indica o valor inicial do objeto e tem um comportamento Booleano, ou seja, se o valor é Verdadeiro, o objeto inicia</p><p>selecionado e, do contrário, o estado inicial é não selecionado. O valor padrão desta propriedade é Falso.</p><p>WordWrap</p><p>Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para o texto ultrapasse os limites</p><p>determinados no objeto. Para que esta propriedade funcione, a propriedade Multiline deve ser obrigatoriamente</p><p>igual a Verdadeiro.</p><p>4.3.2.14.6 Botão Incremento-Decremento</p><p>Esta seção contém informações sobre eventos e propriedades do objeto Botão Incremento-Decremento (Spinbutton).</p><p>Este objeto não possui métodos associados.</p><p>4.3.2.14.6.1 Eventos</p><p>Esta seção contém informações sobre os eventos do objeto Botão Incremento-Decremento (Spinbutton).</p><p>SpinDown</p><p>SpinDown()</p><p>Ocorre quando o usuário pressiona a tecla de seta para baixo. Este evento decrementa a propriedade Value do</p><p>objeto.</p><p>SpinUp</p><p>SpinUp()</p><p>Ocorre quando o usuário pressiona a tecla de seta para cima. Este evento incrementa a propriedade Value do objeto.</p><p>4.3.2.14.6.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Botão Incremento-Decremento (Spinbutton).</p><p>Delay</p><p>Especifica um tempo de espera para o objeto. Esta propriedade afeta a duração de tempo entre os eventos SpinUp,</p><p>SpinDown e Change consecutivos, gerados quando o usuário clica e mantém pressionado o botão Incremento-</p><p>Decremento. O primeiro evento ocorre imediatamente. O tempo de espera até a segunda ocorrência do evento é de 5</p><p>(cinco) vezes o valor especificado nesta propriedade. Após o tempo inicial, o intervalo entre os eventos é o valor</p><p>especificado para esta propriedade. O valor padrão desta propriedade é 50 ms. Isto significa que o objeto inicia o</p><p>primeiro evento depois de 250 ms, ou 5 (cinco) vezes o valor especificado, e inicia cada evento subsequente depois</p><p>de 50 ms.</p><p>Max</p><p>Esta propriedade é utilizada para determinar o limite máximo do objeto.</p><p>Min</p><p>Esta propriedade é utilizada para determinar o limite mínimo do objeto.</p><p>Orientation</p><p>Esta propriedade é utilizada para determinar a orientação do objeto na Tela. Os valores possíveis para esta</p><p>propriedade são -1 - fmOrientationAuto: Determina automaticamente a orientação com base nas dimensões do</p><p>objeto, isto é, conforme foi criado (padrão), 0 - fmOrientationVertical: O objeto é disposto verticalmente ou 1 -</p><p>fmOrientationHorizontal: O objeto é disposto horizontalmente.</p><p>SmallChange</p><p>Esta propriedade especifica a quantidade de movimento que ocorre quando o usuário clica em uma seta de</p><p>rolagem no objeto. O valor padrão desta propriedade é 1 (um).</p><p>Value</p><p>Visualização</p><p>142</p><p>Um número inteiro entre os valores definidos pelas propriedades Min e Max. Indica a posição inicial do incremento</p><p>ou decremento. Não aceita valores menores que o valor da propriedade Min nem maiores que o valor da</p><p>propriedade Max.</p><p>4.3.2.14.7 Botão Liga-Desliga</p><p>Esta seção contém informações sobre eventos e propriedades do objeto Botão Liga-Desliga (MdcToggleButton). Este</p><p>objeto não possui métodos associados.</p><p>4.3.2.14.7.1 Eventos</p><p>Esta seção contém informações sobre os eventos do objeto Botão Liga-Desliga (MdcToggleButton).</p><p>MouseMove</p><p>MouseMove()</p><p>Ocorre quando o ponteiro do mouse é movimentado sobre o botão Liga-Desliga.</p><p>4.3.2.14.7.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Botão Liga-Desliga (MdcToggleButton).</p><p>Accelerator</p><p>Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora é uma tecla que, usada em conjunto com a</p><p>tecla ALT, move o foco para o objeto. O valor padrão desta propriedade é uma String vazia.</p><p>Alignment</p><p>Esta propriedade especifica a posição do objeto, relativa à legenda. Os valores possíveis para esta propriedade</p><p>são 0 - fmAlignmentLeft: Coloca a legenda à esquerda do objeto ou 1 - fmAligmentRight: Coloca a legenda à</p><p>direita do objeto (padrão). Esta propriedade não pode ser alterada com o objeto ativo.</p><p>AutoSize</p><p>Esta propriedade ajusta a largura do texto, caso a área disponível ultrapasse o tamanho do objeto. Para o objeto</p><p>Botão Liga-Desliga (Toggle Button), quando esta propriedade está configurada para Verdadeiro, o texto é</p><p>redimensionado para coincidir com o tamanho atual o objeto, permitindo assim a exibição completa.</p><p>BackStyle</p><p>Esta propriedade define o estilo do plano de fundo para o objeto. Os valores possíveis para esta propriedade são</p><p>0 - fmBackStyleTransparent: Define o objeto como transparente, isto é, nenhum fundo deste objeto é desenhado, ou</p><p>1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é desenhado (padrão).</p><p>NOTA</p><p>Esta propriedade não afeta a transparência de bitmaps. Deve-se usar um editor de imagens como o Paintbrush, por</p><p>exemplo, para tornar um bitmap transparente. Nem todos os objetos ActiveX suportam bitmaps transparentes.</p><p>Caption</p><p>Define o texto que é mostrado no objeto.</p><p>Font</p><p>Esta propriedade é utilizada para determinar a fonte do objeto Botão Liga-Desliga. Esta propriedade não pode ser</p><p>utilizada em Associações e contém as subpropriedades descritas no tópico Fonte.</p><p>GroupName</p><p>Esta propriedade é utilizada para criar um grupo de objetos mutuamente exclusivos. Esta propriedade não pode</p><p>ser alterada com o objeto ativo.</p><p>NOTA</p><p>Esta propriedade não é utilizada no Elipse E3 e foi mantida por motivos de compatibilidade com a especificação</p><p>padrão dos objetos Microsoft Forms.</p><p>Locked</p><p>Esta propriedade habilita ou desabilita a edição do objeto. Se esta propriedade está configurada para Verdadeiro,</p><p>a edição não é permitida. Caso contrário, é possível editar o objeto. Os valores configurados na propriedade Enabled</p><p>143</p><p>Visualização</p><p>influenciam o comportamento desta propriedade. Para mais detalhes, consulte a propriedade Enabled. O valor</p><p>padrão desta propriedade é Falso.</p><p>Picture</p><p>Esta propriedade especifica a figura (bitmap) atribuída ao objeto. Um arquivo com imagem pode ser selecionado</p><p>através da Lista de Propriedades ou via scripts, utilizando-se a função LoadPicture para especificar o caminho e o</p><p>nome do arquivo que contém a figura. Para remover a figura, clique no valor desta propriedade e pressione a tecla</p><p>DEL. A tecla BACKSPACE (tecla de espaço do teclado) não remove a figura.</p><p>PicturePosition</p><p>Esta propriedade especifica a posição da figura atribuída ao objeto em relação à legenda. As opções disponíveis</p><p>para esta propriedade estão descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade PicturePosition</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - fmPicturePositionLeftTop A figura aparece à esquerda da legenda. A legenda é</p><p>alinhada com a parte superior</p><p>da figura</p><p>1 - fmPicturePositionLeftCenter A figura aparece à esquerda da legenda. A legenda é</p><p>centralizada relativamente à imagem</p><p>2 - fmPicturePositionLeftBottom A figura aparece à esquerda da legenda. A legenda é</p><p>alinhada com a parte inferior da figura</p><p>3 - fmPicturePositionRightTop A figura aparece à direita da legenda. A legenda é</p><p>alinhada com a parte superior da figura</p><p>4 - fmPicturePositionRightCenter A figura aparece à direita da legenda. A legenda é</p><p>centralizada relativamente à figura</p><p>5 - fmPicturePositionRightBottom A figura aparece à direita da legenda. A legenda é</p><p>alinhada com a parte inferior da figura</p><p>6 - fmPicturePositionAboveLeft A figura aparece acima da legenda. A legenda é alinhada</p><p>com a extremidade esquerda da figura</p><p>7 - fmPicturePositionAboveCenter A figura aparece acima da legenda. A legenda é</p><p>centralizada abaixo da figura (padrão)</p><p>8 - fmPicturePositionAboveRight A figura aparece acima da legenda. A legenda é alinhada</p><p>com a extremidade direita da figura</p><p>9 - fmPicturePositionBelowLeft A figura aparece abaixo da legenda. A legenda é</p><p>alinhada com a extremidade esquerda da figura</p><p>10 - fmPicturePositionBelowCenter A figura aparece abaixo da legenda. A legenda é</p><p>centralizada acima da figura</p><p>11 - fmPicturePositionBelowRight A figura aparece abaixo da legenda. A legenda é</p><p>alinhada com a extremidade direita da figura</p><p>12 - fmPicturePositionCenter A figura aparece no centro do controle. A legenda é</p><p>centralizada horizontalmente e verticalmente sobre a</p><p>figura</p><p>SpecialEffect</p><p>Esta propriedade especifica a aparência de um objeto. Esta propriedade não pode ser alterada com o objeto</p><p>ativo. As opções disponíveis para esta propriedade estão descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade SpecialEffect</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - fmSpecialEffectFlat O objeto aparece plano e possui um destaque na borda,</p><p>uma alteração de cor ou ambos</p><p>1 - fmSpecialEffectRaised O objeto possui um destaque na parte superior</p><p>esquerda e uma sombra na parte inferior direita. O</p><p>objeto parece estar em relevo (padrão)</p><p>https://learn.microsoft.com/pt-br/office/vba/api/access.application.loadpicture</p><p>Visualização</p><p>144</p><p>OPÇÃO DESCRIÇÃO</p><p>2 - fmSpecialEffectSunken O objeto possui uma sombra na parte superior esquerda</p><p>e um destaque na parte inferior direita. O objeto e a</p><p>borda parecem estar afundados na Tela</p><p>3 - fmSpecialEffectEtched A borda parece estar esculpida ao redor da extremidade</p><p>do objeto</p><p>6 - fmSpecialEffectBump O objeto possui um ressalto na parte inferior direita e</p><p>parece plano na parte superior esquerda</p><p>TextAlign</p><p>Especifica como o texto é alinhado no objeto. Os valores possíveis para esta propriedade são 1 -</p><p>fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto, 2 - fmTextAlignCenter: Alinha o texto ao</p><p>centro do objeto (padrão) ou 3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto.</p><p>TripleState</p><p>Esta propriedade determina até 3 (três) estados de valores para o objeto. Se esta propriedade está configurada</p><p>para Verdadeiro, o usuário pode selecionar entre as opções de estados Falso, Verdadeiro ou Nulo. O valor Nulo é</p><p>exibido como um botão sombreado. Caso contrário, o usuário pode selecionar entre os valores Falso ou Verdadeiro.</p><p>O valor padrão desta propriedade é Falso.</p><p>Value</p><p>Indica o valor inicial do objeto e tem comportamento Booleano, ou seja, se o valor é Verdadeiro, o objeto inicia</p><p>selecionado e, do contrário, o estado inicial é não selecionado. O valor padrão desta propriedade é Falso.</p><p>WordWrap</p><p>Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para o texto ultrapasse os limites</p><p>determinados no objeto.</p><p>4.3.2.14.8 Caixa de Seleção</p><p>Esta seção contém informações sobre propriedades do objeto Caixa de Seleção (MdcCheckBox). Este objeto não</p><p>possui eventos nem métodos associados.</p><p>4.3.2.14.8.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Caixa de Seleção (MdcCheckBox).</p><p>Accelerator</p><p>Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora é uma tecla que, usada em conjunto com a</p><p>tecla ALT, move o foco para o objeto. O valor padrão desta propriedade é uma String vazia.</p><p>Alignment</p><p>Esta propriedade especifica a posição do objeto relativa à legenda. Os valores possíveis para esta propriedade</p><p>são 0 - fmAlignmentLeft: Coloca a legenda à esquerda do objeto ou 1 - fmAligmentRight: Coloca a legenda à</p><p>direita do objeto (padrão).</p><p>AutoSize</p><p>Esta propriedade ajusta a largura do texto caso a área disponível ultrapasse o tamanho do objeto. Quando esta</p><p>propriedade está configurada para Verdadeiro, o texto é redimensionado para coincidir com o tamanho atual do</p><p>objeto.</p><p>BackStyle</p><p>Esta propriedade define o estilo do plano de fundo para os objetos. Os valores possíveis para esta propriedade</p><p>são 0 - fmBackStyleTransparent: Define o objeto como transparente, isto é, nenhum fundo deste objeto é</p><p>desenhado, ou 1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é desenhado (padrão).</p><p>NOTA</p><p>Esta propriedade não afeta a transparência de bitmaps. Deve-se usar um editor de imagens como o Paintbrush, por</p><p>exemplo, para tornar um bitmap transparente. Nem todos os objetos ActiveX suportam bitmaps transparentes.</p><p>Caption</p><p>Define o texto que é mostrado no objeto.</p><p>145</p><p>Visualização</p><p>Font</p><p>Esta propriedade é utilizada para determinar a fonte do objeto Caixa de Seleção. Esta propriedade não pode ser</p><p>utilizada em Associações e contém as subpropriedades descritas no tópico Fonte.</p><p>GroupName</p><p>Esta propriedade é utilizada para criar um grupo de objetos mutuamente exclusivos.</p><p>NOTA</p><p>Esta propriedade não é utilizada no Elipse E3 e foi mantida por motivos de compatibilidade com a especificação</p><p>padrão dos objetos Microsoft Forms.</p><p>Locked</p><p>Esta propriedade habilita ou desabilita a edição do objeto. Se esta propriedade está configurada para Verdadeiro,</p><p>a edição não é permitida. Caso contrário, é possível editar o objeto. Os valores configurados na propriedade Enabled</p><p>influenciam o comportamento desta propriedade. Para mais detalhes, consulte a propriedade Enabled. O valor</p><p>padrão desta propriedade é Falso.</p><p>Picture</p><p>Esta propriedade especifica a figura (bitmap) atribuída ao objeto. Um arquivo com imagem pode ser selecionado</p><p>através da Lista de Propriedades ou via scripts, utilizando-se a função LoadPicture para especificar o caminho e o</p><p>nome do arquivo que contém a figura. Para remover a figura, clique no valor desta propriedade e pressione a tecla</p><p>DEL. A tecla BACKSPACE (tecla de espaço do teclado) não remove a figura. O script a seguir contém um exemplo de</p><p>uso desta propriedade.</p><p>Sub CommandButton1_Click()</p><p>Screen.Item("CheckBox1").Picture = LoadPicture("C:\aba.gif")</p><p>End Sub</p><p>PicturePosition</p><p>Esta propriedade especifica a posição da figura atribuída ao objeto em relação à legenda. As opções disponíveis</p><p>para esta propriedades estão descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade PicturePosition</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - fmPicturePositionLeftTop A figura aparece à esquerda da legenda. A legenda é</p><p>alinhada com a parte superior da figura</p><p>1 - fmPicturePositionLeftCenter A figura aparece à esquerda da legenda. A legenda é</p><p>centralizada relativamente à imagem</p><p>2 - fmPicturePositionLeftBottom A figura aparece à esquerda da legenda. A legenda é</p><p>alinhada com a parte inferior da figura</p><p>3 - fmPicturePositionRightTop A figura aparece à direita da legenda. A legenda é</p><p>alinhada com a parte superior da figura</p><p>4 - fmPicturePositionRightCenter A figura aparece à direita da legenda. A legenda é</p><p>centralizada relativamente à figura</p><p>5 - fmPicturePositionRightBottom A figura aparece à direita da legenda. A legenda é</p><p>alinhada com a parte inferior da</p><p>figura</p><p>6 - fmPicturePositionAboveLeft A figura aparece acima da legenda. A legenda é alinhada</p><p>com a extremidade esquerda da figura</p><p>7 - fmPicturePositionAboveCenter A figura aparece acima da legenda. A legenda é</p><p>centralizada abaixo da figura (padrão)</p><p>8 - fmPicturePositionAboveRight A figura aparece acima da legenda. A legenda é alinhada</p><p>com a extremidade direita da figura</p><p>9 - fmPicturePositionBelowLeft A figura aparece abaixo da legenda. A legenda é</p><p>alinhada com a extremidade esquerda da figura</p><p>10 - fmPicturePositionBelowCenter A figura aparece abaixo da legenda. A legenda é</p><p>centralizada acima da figura</p><p>11 - fmPicturePositionBelowRight A figura aparece abaixo da legenda. A legenda é</p><p>alinhada com a extremidade direita da figura</p><p>https://learn.microsoft.com/pt-br/office/vba/api/access.application.loadpicture</p><p>Visualização</p><p>146</p><p>OPÇÃO DESCRIÇÃO</p><p>12 - fmPicturePositionCenter A figura aparece no centro do controle. A legenda é</p><p>centralizada horizontalmente e verticalmente sobre a</p><p>figura.</p><p>SpecialEffect</p><p>Esta propriedade especifica a aparência de um objeto. As opções disponíveis para esta propriedade estão</p><p>descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade SpecialEffect</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - fmButtonEffectFlat O objeto aparece plano e possui um destaque na borda,</p><p>uma alteração de cor ou ambos</p><p>2 - fmButtonEffectSunken O objeto possui uma sombra na parte superior esquerda</p><p>e um destaque na parte inferior direita, como se</p><p>estivesse afundado na Tela (padrão)</p><p>TextAlign</p><p>Especifica como o texto é alinhado neste objeto. Os valores possíveis para esta propriedade são 1 -</p><p>fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto (padrão), 2 - fmTextAlignCenter: Alinha o</p><p>texto com o centro do objeto ou 3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto.</p><p>TripleState</p><p>Esta propriedade determina até 3 (três) estados de valores para o objeto. Se esta propriedade está configurada</p><p>para Verdadeiro, o usuário pode selecionar entre as opções de estados Falso, Verdadeiro ou Nulo. O valor Nulo é</p><p>exibido como um botão sombreado. Caso contrário, o usuário pode selecionar entre os valores Falso ou Verdadeiro.</p><p>O valor padrão desta propriedade é Falso.</p><p>Value</p><p>Indica o valor inicial do objeto e tem comportamento Booleano, ou seja, se o valor é Verdadeiro, o objeto inicia</p><p>selecionado e, do contrário, o estado inicial é não selecionado. O valor padrão desta propriedade é Falso.</p><p>WordWrap</p><p>Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para o texto ultrapasse os limites</p><p>determinados no objeto.</p><p>4.3.2.14.9 Editor de Texto</p><p>Esta seção contém informações sobre eventos, métodos e propriedades do objeto Editor de Texto (MdcText).</p><p>4.3.2.14.9.1 Eventos</p><p>Esta seção contém informações sobre os eventos do objeto Editor de Texto (MdcText).</p><p>DropButtonClick</p><p>DropButtonClick()</p><p>Ocorre quando a lista de opções aparece ou desaparece ao se clicar no objeto.</p><p>4.3.2.14.9.2 Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Editor de Texto (MdcText).</p><p>Copy</p><p>Copy()</p><p>Copia para a Área de Transferência um texto previamente selecionado. Utilize o método Paste para colar o texto em</p><p>outro local.</p><p>Cut</p><p>Cut()</p><p>Recorta para a Área de Transferência um texto previamente selecionado. Utilize o método Paste para colar o texto em</p><p>outro local.</p><p>147</p><p>Visualização</p><p>Paste</p><p>Paste()</p><p>Insere em um objeto de texto o conteúdo da Área de Transferência.</p><p>4.3.2.14.9.3 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Editor de Texto (MdcText).</p><p>AutoSize</p><p>Esta propriedade ajusta a largura do texto, caso a área disponível ultrapasse o tamanho do objeto. Para o objeto</p><p>Editor de Texto (Text Box), quando esta propriedade está configurada para Verdadeiro, a largura do texto é</p><p>reajustada para a mesma largura do objeto. O valor padrão desta propriedade é Falso.</p><p>NOTA</p><p>Recomenda-se evitar o uso desta propriedade com um Editor de Texto vazio, que também utilize as propriedades</p><p>Multiline e WordWrap. Quando o usuário digita em um Editor de Texto com estas propriedades ajustadas para</p><p>Verdadeiro, automaticamente o objeto se redimensiona como uma caixa longa e estreita, com um caractere de</p><p>largura e uma linha de texto de comprimento.</p><p>AutoTab</p><p>Esta propriedade habilita ou desabilita a tabulação automática no objeto. Se esta propriedade está configurada</p><p>para Verdadeiro, a tabulação automática ocorre. Caso contrário, não é utilizada. Após o usuário digitar o número</p><p>máximo de caracteres em um objeto, configurado na propriedade MaxLength, o foco se move automaticamente para</p><p>o próximo objeto da ordem de tabulação, quando estes caracteres são atingidos. Por exemplo, quando se quer que</p><p>um Editor de Texto exiba dados de estoque que possuam sempre 5 (cinco) caracteres, pode-se usar a propriedade</p><p>MaxLength para especificar o número máximo de caracteres a serem introduzidos no objeto e esta propriedade para</p><p>tabular automaticamente para o próximo objeto depois que o usuário digitar 5 (cinco) caracteres.</p><p>AutoWordSelect</p><p>Habilita ou desabilita a seleção automática de palavras no objeto. Se esta propriedade está configurada para</p><p>Verdadeiro, a palavra indicada é selecionada no texto mais o espaço seguinte, caso se tenha selecionado parte da</p><p>palavra. Caso contrário, somente o caractere indicado na palavra é selecionado.</p><p>BackStyle</p><p>Esta propriedade define o estilo do plano de fundo para os objetos. Os valores possíveis para esta propriedade</p><p>são 0 - fmBackStyleTransparent: Define o objeto como transparente, isto é, nenhum fundo deste objeto é</p><p>desenhado, ou 1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é desenhado (padrão).</p><p>NOTA</p><p>Esta propriedade não afeta a transparência de bitmaps. Deve-se usar um editor de imagens como o Paintbrush, por</p><p>exemplo, para tornar um bitmap transparente. Nem todos os objetos ActiveX suportam bitmaps transparentes.</p><p>BorderColor</p><p>Esta propriedade determina a cor da borda que é aplicada no objeto. Com esta propriedade, é possível aplicar a</p><p>cor padrão ou personalizá-la através de edição. Para que esta propriedade seja aplicável, é necessário que a</p><p>propriedade BorderStyle esteja configurada para 1 - fmBorderStyleSingle. O valor padrão desta propriedade é</p><p>preto (RGB(0, 0, 0)).</p><p>BorderStyle</p><p>Esta propriedade determina o estilo de borda que é aplicada ao objeto. Os valores possíveis para esta</p><p>propriedade são 0 - fmBorderStyleNone: Sem borda (padrão) ou 1 - fmBorderStyleSingle: Com borda simples.</p><p>CanPaste</p><p>Esta propriedade especifica se a Área de Transferência contém os dados aos quais o objeto dá suporte. Se esta</p><p>opção está configurada para Verdadeiro, o objeto pode receber informações coladas da Área de Transferência. Se os</p><p>dados da Área de Transferência estão em um formato ao qual o objeto não dá suporte, o valor desta propriedade é</p><p>Falso. Por exemplo, ao se tentar colar um bitmap em um objeto que só dê suporte a texto, o valor desta propriedade</p><p>é Falso. Esta propriedade é somente de leitura.</p><p>CurLine</p><p>Especifica a linha corrente do objeto, ou seja, a linha que contém o ponto de inserção de texto. O número da</p><p>primeira linha é 0 (zero). O valor padrão desta propriedade é 0 (zero).</p><p>Visualização</p><p>148</p><p>CurTargetX</p><p>Retorna a posição horizontal de inserção de um texto no objeto. Esta posição é medida em unidades himétricas, em</p><p>que um himetro corresponde a 0,0001 de 1 (um) metro. Pode-se usar esta propriedade e a propriedade CurX para</p><p>mover o ponto de inserção de um texto conforme o usuário percorre o conteúdo do objeto. Quando o usuário</p><p>move</p><p>o ponto de inserção para outra linha do texto, esta propriedade especifica a posição mais indicada para o ponto de</p><p>inserção do texto desejado. A propriedade CurX é definida neste valor, se a linha do texto é maior que o valor desta</p><p>propriedade. Caso contrário, a propriedade CurX é definida como o final da linha do texto. Esta propriedade é</p><p>somente de leitura.</p><p>CurX</p><p>Esta propriedade especifica a posição atual horizontal do ponto de inserção no objeto. Esta propriedade é aplicada</p><p>em um objeto que possua várias linhas, isto é, cuja propriedade Multiline está habilitada. O valor de retorno é válido</p><p>quando o objeto possui o foco. Pode-se usar a propriedade Multiline e esta propriedade para posicionar o ponto</p><p>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</p><p>ponto de inserção para uma outra linha de texto rolando o conteúdo do objeto, a propriedade CurTargetX especifica</p><p>a posição desejada para o ponto de inserção. Esta propriedade é definida com este valor se a linha de texto é maior</p><p>do que o valor da propriedade CurTargetX. Caso contrário, esta propriedade é definida no fim da linha de texto. Esta</p><p>propriedade não pode ser alterada com o objeto ativo.</p><p>DragBehavior</p><p>Habilita ou desabilita o recurso de arrastar e soltar um texto no conteúdo do objeto. Os valores possíveis para esta</p><p>propriedade são 0 - fmDragBehaviorDisabled: Não permite a ação de arrastar e soltar o texto no conteúdo do</p><p>objeto (padrão) ou 1 - fmDragBehaviorEnabled: Permite a ação de arrastar e soltar o texto no conteúdo do objeto.</p><p>NOTA</p><p>Esta propriedade não tem efeito se a propriedade Style está configurada para 2 - fmStyleDropDownList.</p><p>EnterFieldBehavior</p><p>Esta propriedade controla a forma como o conteúdo do texto é selecionado na área de edição quando se</p><p>pressiona a tecla TAB no objeto e não quando o objeto recebe o foco como um resultado do método SetFocus. Os</p><p>valores possíveis para esta propriedade são 0 - fmEnterFieldBehaviorSelectAll: Seleciona todo o conteúdo do texto</p><p>quando a tecla TAB é pressionada no objeto (padrão) ou 1 - fmEnterFieldBehaviorRecallSelection: A seleção</p><p>permanece inalterada.</p><p>EnterKeyBehavior</p><p>Define o efeito da tecla ENTER no objeto. Se esta propriedade está configurada para Verdadeiro, ao pressionar a</p><p>tecla ENTER uma nova linha é criada na área de edição do texto no objeto. Caso contrário, ao pressionar a tecla</p><p>ENTER o foco é passado para o próximo objeto da ordem de tabulação. Isto também ocorre se a propriedade</p><p>Multiline está configurada para Falso, independente do valor desta propriedade. O atalho de teclado CTRL + ENTER</p><p>também depende do valor da propriedade Multiline. Se esta propriedade está configurada para Verdadeiro, ao</p><p>pressionar estas teclas uma nova linha é criada na área de edição do texto do objeto, independente do valor desta</p><p>propriedade. Se o valor desta propriedade é Falso, as teclas não têm efeito sobre o texto.</p><p>Font</p><p>Esta propriedade é utilizada para determinar a fonte do objeto Editor de Texto. Esta propriedade não pode ser</p><p>utilizada em Associações e contém as subpropriedades descritas no tópico Fonte.</p><p>HideSelection</p><p>Esta propriedade especifica se o texto selecionado continua em destaque quando um objeto não tem mais o foco.</p><p>Se esta propriedade está configurada para Verdadeiro, o texto selecionado não está em destaque, a menos que o</p><p>objeto tenha o foco. Caso contrário, o texto selecionado sempre aparece em destaque. O valor padrão desta</p><p>propriedade é Verdadeiro.</p><p>IMEMode</p><p>Esta propriedade especifica o modo IME (Input Method Editor) do objeto Editor de Texto.</p><p>NOTA</p><p>Esta propriedade se aplica apenas a programas escritos em idiomas asiáticos (chinês simplificado, chinês tradicional,</p><p>coreano e japonês) e é ignorada em outros programas. Foi mantida por motivos de compatibilidade com a</p><p>especificação padrão dos objetos Microsoft Forms.</p><p>149</p><p>Visualização</p><p>As opções disponíveis para esta propriedade estão descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade IMEMode</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - fmIMEModeNoControl Não controla o modo IME (padrão)</p><p>1 - fmIMEModeOn Modo IME ativado</p><p>2 - fmIMEModeOff Modo IME desativado. Modo inglês</p><p>3 - fmIMEModeDisable Modo IME desativado. O usuário não pode ativar o</p><p>modo IME pelo teclado</p><p>4 - fmIMEModeHiragana Modo IME ativado com modo Hiragana de largura total</p><p>5 - fmIMEModeKatakana Modo IME ativado com modo Katakana de largura total</p><p>6 - fmIMEModeKatakanaHalf Modo IME ativado com modo Katakana de meia largura</p><p>7 - fmIMEModeAlphaFull Modo IME ativado com modo Alfanumérico de largura</p><p>total</p><p>8 - fmIMEModeAlpha Modo IME ativado com modo Alfanumérico de meia</p><p>largura</p><p>9 - fmIMEModeHangulFull Modo IME ativado com modo Hangul de largura total</p><p>10 - fmIMEModeHangul Modo IME ativado com modo Hangul de meia largura</p><p>11 - fmIMEModeHanziFull Modo IME ativado com modo Hanzi de largura total</p><p>12 - fmIMEModeHanzi Modo IME ativado com modo Hanzi de meia largura</p><p>IntegralHeight</p><p>Esta propriedade ajusta a altura da área de edição do texto, caso a área disponível ultrapasse o tamanho do</p><p>objeto. Se esta propriedade está configurada para Verdadeiro, a altura da área de edição do texto é reajustada para</p><p>coincidir com o tamanho atual do objeto, permitindo assim a exibição completa do conteúdo do texto. Caso contrário,</p><p>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</p><p>não são exibidos no objeto.</p><p>LineCount</p><p>Esta propriedade retorna o número de linhas do objeto. Esta propriedade é somente de leitura.</p><p>Locked</p><p>Esta propriedade habilita ou desabilita a edição do objeto. Se esta propriedade está configurada para Verdadeiro,</p><p>a edição não é permitida. Caso contrário, é possível editar o objeto. Os valores configurados na propriedade Enabled</p><p>influenciam o comportamento desta propriedade. Para mais detalhes, consulte a propriedade Enabled. O valor</p><p>padrão desta propriedade é Falso.</p><p>MaxLength</p><p>Esta propriedade determina o número máximo de caracteres no objeto. Se esta propriedade está configurada com</p><p>o valor 0 (zero), não há limite de caracteres no objeto.</p><p>Multiline</p><p>Esta propriedade indica se o texto tem múltiplas linhas (Verdadeiro) ou é uma caixa de texto simples (Falso). Isto</p><p>pode ser visualizado quando o Elipse E3 Viewer está em execução. O valor padrão desta propriedade é Falso.</p><p>PasswordChar</p><p>Converte o texto do objeto para um caractere especial, configurado nesta propriedade. Utilize esta propriedade</p><p>para proteger informações sensíveis, como senhas ou códigos de segurança. O valor desta propriedade é o</p><p>caractere, normalmente um asterisco, que aparece em um objeto, ao invés dos caracteres reais que o usuário digita.</p><p>Se um caractere não é especificado, o controle exibe os caracteres digitados pelo usuário.</p><p>ScrollBars</p><p>Especifica se o objeto possui barras de rolagem verticais, horizontais ou ambas. Os valores possíveis para esta</p><p>propriedade são 0 - fmScrollBarsNone: Não exibe barras de rolagem (padrão), 1 - fmScrollBarsHorizontal: Exibe</p><p>uma barra de rolagem horizontal, 2 - fmScrollBarsVertical: Exibe uma barra de rolagem vertical ou 3 -</p><p>fmScrollBarsBoth: Exibe tanto a barra de rolagem vertical quanto a barra de rolagem horizontal.</p><p>Visualização</p><p>150</p><p>SelectionMargin</p><p>Habilita ou desabilita a margem de seleção do objeto. Se esta propriedade está configurada para Verdadeiro, ao</p><p>clicar na margem do objeto o texto é selecionado. Caso contrário, ao clicar na margem o texto não é selecionado.</p><p>NOTA</p><p>Se esta propriedade está configurada para Verdadeiro quando o objeto é impresso, a margem de seleção também</p><p>é impressa.</p><p>SelLength</p><p>Retorna o número de caracteres selecionados no objeto. Esta propriedade</p><p>não pode ser alterada com o objeto</p><p>ativo.</p><p>SelStart</p><p>Indica o ponto inicial do texto selecionado ou o ponto de inserção, se nenhum texto é selecionado. Esta propriedade</p><p>não pode ser alterada com o objeto ativo.</p><p>SelText</p><p>Retorna o texto selecionado no objeto. Esta propriedade não pode ser alterada com o objeto ativo.</p><p>SpecialEffect</p><p>Esta propriedade especifica a aparência de um objeto. As opções disponíveis para esta propriedade estão</p><p>descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade SpecialEffect</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - fmSpecialEffectFlat O objeto aparece plano e possui um destaque na borda,</p><p>uma alteração de cor ou ambos</p><p>1 - fmSpecialEffectRaised O objeto possui um destaque na parte superior</p><p>esquerda e uma sombra na parte inferior direita. O</p><p>objeto parece estar em relevo</p><p>2 - fmSpecialEffectSunken O objeto possui uma sombra na parte superior esquerda</p><p>e um destaque na parte inferior direita. O objeto e a</p><p>borda parecem estar afundados na Tela (padrão)</p><p>3 - fmSpecialEffectEtched A borda parece estar esculpida ao redor da extremidade</p><p>do objeto</p><p>6 - fmSpecialEffectBump O objeto possui um ressalto na parte inferior direita e</p><p>parece plano na parte superior esquerda</p><p>TabKeyBehavior</p><p>Determina se as tabulações são permitidas na região de edição. Se esta propriedade está configurada para</p><p>Verdadeiro, ao pressionar a tecla TAB é inserido um caractere de espaçamento na região de edição. Caso contrário,</p><p>ao pressionar TAB, o foco é passado para o próximo objeto na ordem de tabulação.</p><p>Text</p><p>Retorna o texto sendo digitado na opção selecionada. Esta propriedade não pode ser alterada com o objeto ativo.</p><p>TextAlign</p><p>Especifica como o texto é alinhado no objeto. Os valores possíveis para esta propriedade são 1 -</p><p>fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto (padrão), 2 - fmTextAlignCenter: Alinha o</p><p>texto com o centro do objeto ou 3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto.</p><p>TextLength</p><p>Retorna o número de caracteres digitados no objeto. Esta propriedade é somente de leitura.</p><p>Value</p><p>Este é o texto na área de edição. Esta propriedade é do tipo Variant, e pode assumir valores de todo e qualquer</p><p>tipo, tais como Date, Boolean, ou String, entre outros.</p><p>WordWrap</p><p>151</p><p>Visualização</p><p>Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para o texto ultrapasse os limites</p><p>determinados no objeto. Para que esta propriedade funcione, a propriedade Multiline deve ser obrigatoriamente</p><p>igual a Verdadeiro.</p><p>4.3.2.14.10 Fonte</p><p>Esta seção contém informações sobre propriedades do objeto Fonte (Font) retornado pelas propriedades Font</p><p>dos objetos MS Forms, com exceção dos objetos Barra de Rolagem e Botão Incremento-Decremento. Este objeto não</p><p>possui eventos nem métodos associados.</p><p>4.3.2.14.10.1 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Fonte (Font) retornado pelas propriedades Font</p><p>dos objetos MS Forms, com exceção dos objetos Barra de Rolagem e Botão Incremento-Decremento.</p><p>Bold</p><p>Esta propriedade indica se o texto do objeto MS Forms está em negrito.</p><p>Charset</p><p>Esta propriedade indica o conjunto de caracteres disponível para a fonte do objeto MS Forms. Os valores possíveis</p><p>para esta propriedade estão descritos na tabela a seguir.</p><p>Valores disponíveis para a propriedade Charset</p><p>VALOR PÁGINA DE CÓDIGO NOME DESCRIÇÃO</p><p>0 1252 ANSI_CHARSET ANSI (American National</p><p>Standards Institute)</p><p>1 -- DEFAULT_CHARSET Padrão (mostra o conjunto</p><p>de caracteres disponível na</p><p>Fonte)</p><p>2 -- SYMBOL_CHARSET Símbolos</p><p>128 932 SHIFTJIS_CHARSET Japonês (Shift-JIS)</p><p>129 949 HANGUL_CHARSET Coreano</p><p>134 936 GB2312_CHARSET Chinês Simplificado (GBK)</p><p>136 950 CHINESEBIG5_CHARSET Chinês Tradicional (Big5)</p><p>161 1253 GREEK_CHARSET Grego</p><p>162 1254 TURKISH_CHARSET Turco</p><p>177 1255 HEBREW_CHARSET Hebraico</p><p>178 1256 ARABIC_CHARSET Árabe</p><p>186 1257 BALTIC_CHARSET Báltico</p><p>204 1251 RUSSIAN_CHARSET Cirílico</p><p>222 874 THAI_CHARSET Tailandês</p><p>238 1250 EE_CHARSET Centro-Europeu</p><p>255 -- OEM_CHARSET OEM (Original Equipment</p><p>Manufacturer)</p><p>Italic</p><p>Esta propriedade indica se o texto do objeto MS Forms está em itálico.</p><p>Name</p><p>Esta propriedade indica o nome da fonte do objeto MS Forms.</p><p>Size</p><p>Esta propriedade indica o tamanho, em pontos, da fonte do texto do objeto MS Forms.</p><p>Strikethrough</p><p>Esta propriedade indica se o texto do objeto MS Forms usa o efeito de tachado.</p><p>Visualização</p><p>152</p><p>Underline</p><p>Esta propriedade indica se o texto do objeto MS Forms usa o efeito de sublinhado.</p><p>Weight</p><p>Esta propriedade indica a variação do efeito de negrito na fonte do objeto MS Forms, ou seja, da propriedade Bold.</p><p>Os valores para esta propriedade podem variar entre 0 (zero, não interfere no efeito de negrito) e 1000.</p><p>4.3.2.14.11 Lista</p><p>Esta seção contém informações sobre métodos e propriedades do objeto Lista (MdcList). Este objeto não possui</p><p>eventos associados.</p><p>4.3.2.14.11.1 Métodos</p><p>Esta seção contém informações sobre os métodos do objeto Lista (MdcList).</p><p>AddItem</p><p>AddItem([pvargItem], [pvargIndex])</p><p>Este método é utilizado para adicionar itens a uma Lista. O parâmetro pvargItem é uma String que contém o texto que</p><p>é adicionado à lista e, se omitido, é acrescentada uma String em branco. O parâmetro pvargIndex é o índice do texto</p><p>na lista e, se omitido, o valor do parâmetro pvargItem é adicionado como último item da lista. O script a seguir</p><p>contém um exemplo de uso deste método.</p><p>Sub CommandButton1_Click()</p><p>EntryCount = EntryCount + 1</p><p>ListBox1.AddItem(EntryCount & " - Selection")</p><p>End Sub</p><p>Clear</p><p>Clear()</p><p>Limpa o texto do objeto.</p><p>RemoveItem</p><p>RemoveItem(pvargIndex)</p><p>Remove itens da Lista. Este método possui o parâmetro pvargIndex, que especifica a linha que é excluída, iniciando em</p><p>0 (zero), ou seja, o primeiro elemento é 0 (zero), o segundo é 1 (um) e assim por diante. O script a seguir contém um</p><p>exemplo de uso deste método.</p><p>Sub CommandButton2_Click()</p><p>List1.SetFocus</p><p>' Verifica se a lista contém dados selecionados</p><p>If List1.ListCount >= 1 Then</p><p>' Se não há nenhuma seleção,</p><p>' seleciona o último dado da lista.</p><p>If List1.ListIndex = -1 Then</p><p>List1.ListIndex = List1.ListCount – 1</p><p>End If</p><p>List1.RemoveItem(List1.ListIndex)</p><p>End If</p><p>End Sub</p><p>4.3.2.14.11.2 Propriedades</p><p>Esta seção contém informações sobre as propriedades do objeto Lista (MdcList).</p><p>BorderColor</p><p>Esta propriedade determina a cor da borda que é aplicada no objeto. Com esta propriedade, é possível aplicar a</p><p>cor padrão ou personalizá-la através de edição. Para que esta propriedade seja aplicável, é necessário que a</p><p>propriedade BorderStyle esteja configurada para 1 - fmBorderStyleSingle. O valor padrão desta propriedade é</p><p>preto (RGB(0, 0, 0)).</p><p>BorderStyle</p><p>Esta propriedade determina o estilo de borda que é aplicada ao objeto. Os valores possíveis para esta</p><p>propriedade são 0 - fmBorderStyleNone: Sem borda (padrão) ou 1 - fmBorderStyleSingle: Com borda simples</p><p>BoundColumn</p><p>Determina a coluna da lista onde os dados são armazenados. Por exemplo, se cada linha contém 8 (oito) itens e</p><p>esta propriedade é igual a 3 (três), o sistema armazena as informações na terceira coluna da linha atualmente</p><p>153</p><p>Visualização</p><p>selecionada. Se o valor desta propriedade é igual a 0 (zero), este valor é passado para a propriedade ListIndex do</p><p>objeto. Se o valor desta propriedade é igual a 1 (um) ou superior, o dado indicado é atribuído à coluna referente ao</p><p>valor especificado nesta propriedade. As colunas são numeradas a partir de 1 (um).</p><p>NOTA</p><p>Esta propriedade não tem efeito no Elipse E3 e foi mantida por motivos</p><p>retorna o objeto de aplicação relacionado ao contexto atual do objeto, e o método GetObject</p><p>procura no servidor por um objeto dentro de Application com o nome fornecido, conforme o exemplo a seguir.</p><p>Sub Button1_Click()</p><p>Application.GetObject("Driver1")._</p><p>Item("tag001").AllowRead = False</p><p>End Sub</p><p>Ou ainda conforme o exemplo a seguir.</p><p>Sub Button1_Click()</p><p>Application.GetObject("Driver1.tag001").AllowRead = False</p><p>End Sub</p><p>O método Item foi utilizado para, a partir da referência de Driver1, localizar o tag001, pois um Driver é uma coleção</p><p>de Tags. Depois de localizado o objeto, as propriedades e métodos podem ser acessados livremente.</p><p>Caso alguma outra operação tivesse que ser realizada com Driver1 ou tag001, outra alternativa para o script anterior</p><p>seria a do exemplo a seguir.</p><p>Sub Retangulo1_Click()</p><p>Set obj = Application.GetObject("Driver1")</p><p>obj.Item("tag001").AllowRead = False</p><p>obj.Item("tag002").AllowRead = False</p><p>End Sub</p><p>Programando no Elipse E3</p><p>16</p><p>Neste caso, a variável obj está apontando para o objeto Driver1 e, na próxima vez que se quiser acessar algum</p><p>objeto que descende de Driver1 dentro do script, pode-se utilizar a variável obj diretamente. Isto traz um ganho de</p><p>performance, já que cada chamada do método GetObject executa um acesso ao servidor. Através desta técnica,</p><p>chamadas desnecessárias ao servidor são evitadas. Este exemplo usa o comando Set, que é explicado mais adiante.</p><p>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</p><p>alterar o objeto para executar comandos, mude a linha de atribuição desta variável.</p><p>A palavra Application nos scripts pode indicar tanto funções que são executadas no Elipse E3 Viewer quanto no</p><p>servidor. Neste caso, o objeto Application sabe de antemão quais funções devem ser executadas tanto para um</p><p>quanto para o outro caso. Não é possível, entretanto, executar funções de Elipse E3 Viewer dentro do servidor, assim</p><p>como também não é possível executar funções de servidor dentro do Elipse E3 Viewer.</p><p>2.3.2 Acessando Propriedades do Elipse E3 Studio</p><p>Para acessar um objeto de servidor qualquer em um script que executa no Elipse E3 Studio, pode-se usar a diretiva</p><p>Application.GetObject. A palavra Application retorna o objeto de aplicação relacionado ao contexto atual do objeto,</p><p>e o método GetObject procura no Domínio carregado no Elipse E3 Studio por um objeto da aplicação ou do</p><p>Domínio com o caminho fornecido. No exemplo a seguir, o evento CustomConfig é disparado no Elipse E3 Studio.</p><p>Sub XControl1_CustomConfig</p><p>Application.GetObject("Dados.TagDemo1").DocString = "Documentação"</p><p>End Sub</p><p>2.3.3 Acessando Propriedades do Servidor de dentro do Servidor</p><p>Caso seja necessário acessar as propriedades de um Tag a partir de outro, origem e destino estão no servidor</p><p>ligados via um módulo pai, que é Driver1.</p><p>Nesta situação, deve ser usada a propriedade Parent. Isto permite que seja acessado primeiro o objeto pai onde está</p><p>o script, para depois descer-se na hierarquia em busca de outro elemento, conforme a figura e o exemplo a seguir.</p><p>Driver1 é o objeto pai de Tag1 e</p><p>de Tag2</p><p>Sub Tag1_OnRead()</p><p>Parent.Item("Tag2").AllowRead = False</p><p>End Sub</p><p>Estando-se dentro de um grupo, e desejando-se acessar o mesmo Tag2, pode-se aninhar vários comandos Parent,</p><p>conforme a figura e o exemplo a seguir.</p><p>17</p><p>Programando no Elipse E3</p><p>Pasta1 é o objeto pai de Tag1</p><p>Sub Tag1_OnRead()</p><p>Parent.Parent.Item("Tag2").AllowRead = False</p><p>End Sub</p><p>2.3.4 Acessando Objetos de uma Tela a partir de um Script na Tela</p><p>Deve-se usar somente o método Item, já que os objetos são filhos da Tela, conforme o exemplo a seguir.</p><p>Sub Tela1_OnPreShow(vArg)</p><p>Item("Retangulo1").Visible = True</p><p>End Sub</p><p>Retangulo1 é um item da TelaInicial</p><p>Programando no Elipse E3</p><p>18</p><p>2.3.5 Acessando Objetos de uma Tela a partir de um Script em outro</p><p>Objeto na Tela</p><p>Pode-se usar a propriedade Parent ou o método Screen, conforme a figura e o exemplo a seguir.</p><p>TelaInicial é o objeto pai de</p><p>Retangulo1 e Retangulo2</p><p>Sub Retangulo1_Click()</p><p>Parent.Item("Retangulo2").Visible = True</p><p>End Sub</p><p>2.3.6 Modificando a Tela ou Objetos de Tela a partir do Servidor</p><p>A modificação de um comportamento qualquer em uma Tela só pode ser executada a partir de Associações, em que</p><p>o servidor reporta automaticamente para os Elipse E3 Viewers todas as mudanças das variáveis selecionadas, ou</p><p>através de uma busca explícita do Elipse E3 Viewer por informações no servidor. Toda a operação de associação da</p><p>interface gráfica é realizada do cliente para o servidor, e não do servidor para o cliente. Assim, não é possível</p><p>modificar Telas ou objetos de Tela a partir do servidor via scripts, pois cada cliente de dados tem uma cópia diferente</p><p>das Telas.</p><p>Um exemplo prático é mudar a cor de um Texto na Tela para verde quando um Tag é ligado, ou seja, o valor é</p><p>alterado para 1 (um), e para vermelho quando é desligado, ou seja, o valor é alterado para 0 (zero). Neste caso,</p><p>deve-se simplesmente criar uma Associação Digital entre a propriedade TextColor de Texto1 com Tag1. Associações</p><p>são preferíveis devido à rapidez de execução e simplicidade de manutenção e construção da aplicação.</p><p>19</p><p>Programando no Elipse E3</p><p>Associando a cor do texto ao valor de Tag1</p><p>Uma outra forma de executar o procedimento anterior é criar um script no Viewer que verifique constantemente se</p><p>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</p><p>degrada muito a performance da aplicação. Por isto, esta prática não é aconselhável.</p><p>2.3.7 Acessando Objetos de um ElipseX a partir do próprio ElipseX</p><p>Na criação de um ElipseX, pode-se declarar propriedades (XProperties) e inserir objetos, que podem ser objetos de</p><p>Tela (XControl) ou objetos do servidor (XFolder e XObject). Para se acessar as XProperties através de scripts, acesse o</p><p>nome da propriedade diretamente.</p><p>Programando no Elipse E3</p><p>20</p><p>Aba Design</p><p>Aba Propriedades</p><p>Por exemplo, na figura anterior tem-se o objeto XControl1 com a propriedade Propriedade1, e os objetos Texto1 e</p><p>Retangulo1.</p><p>A propriedade Propriedade1, do tipo Booleano, pode ser acessada com o script a seguir.</p><p>Sub XControl1_OnStartRunning()</p><p>XControl1.Propriedade1 = True</p><p>End Sub</p><p>Ou ainda com o script a seguir.</p><p>Sub XControl1_OnStartRunning()</p><p>Propriedade1 = True</p><p>End Sub</p><p>Se o ElipseX possui objetos internos, então é possível utilizar o método Item para obter uma referência destes</p><p>objetos, como no script a seguir.</p><p>21</p><p>Programando no Elipse E3</p><p>Sub XControl1_OnStartRunning()</p><p>Item("Texto1").Value = "motor"</p><p>Item("Retangulo1").ForegroundColor = RGB(212, 208, 20)</p><p>End Sub</p><p>2.3.8 Acessando Objetos de um ElipseX Externamente</p><p>O acesso externo a um objeto ElipseX só pode ser realizado através das propriedades, utilizando as instâncias</p><p>criadas. Não é possível acessar objetos internos diretamente.</p><p>Se o ElipseX em questão é um XControl, este se comporta como um objeto de Tela. Por exemplo, considere a</p><p>aplicação da figura a seguir.</p><p>Exemplo de XControl</p><p>Para alterar a propriedade Propriedade1 do XControl pode-se executar o script a seguir no evento Click de um Botão</p><p>de Comando.</p><p>Sub CommandButton1_Click()</p><p>Screen.Item("XControl11").Propriedade1 = True</p><p>End Sub</p><p>Ou ainda executar o</p><p>de compatibilidade com a especificação</p><p>padrão dos objetos Microsoft Forms.</p><p>Column</p><p>Especifica a linha e coluna no objeto. Se somente o valor de coluna é especificado, esta propriedade lê ou escreve a</p><p>coluna especificada na linha atual do objeto. Por exemplo, "MinhaListadeSelecao.Column(3)" lê ou escreve a terceira</p><p>coluna do objeto. Esta propriedade não pode ser alterada com o objeto ativo.</p><p>ColumnCount</p><p>Esta propriedade especifica o número de colunas do objeto. Configurar esta propriedade com o valor 0 (zero) não</p><p>exibe nenhuma coluna, e configurar esta propriedade com o valor -1 (menos um) exibe todas as colunas disponíveis.</p><p>O valor padrão desta propriedade é 1 (um).</p><p>ColumnHeads</p><p>Esta propriedade habilita ou desabilita a exibição do título das colunas no objeto. Se esta propriedade está</p><p>configurada para Verdadeiro, o título é mostrado. Caso contrário, o título das colunas não é mostrado. O valor</p><p>padrão desta propriedade é Falso.</p><p>ColumnWidths</p><p>Esta propriedade é utilizada para especificar a largura da coluna do objeto, em pontos. Configurar esta propriedade</p><p>com o valor -1 (menos um) ou em branco indica que a largura é calculada na coluna. A largura mínima de uma coluna</p><p>calculada é 72 pontos, ou uma polegada. Um valor igual a 0 (zero) oculta a coluna. Para produzir colunas mais</p><p>estreitas, deve-se especificar a largura nesta propriedade ou utilizar algum dos valores descritos na tabela a seguir.</p><p>Opções disponíveis para a propriedade ColumnWidths</p><p>OPÇÃO DESCRIÇÃO</p><p>90;72;90 A primeira coluna possui 90 pontos (1,25 polegada), a</p><p>segunda coluna possui 72 pontos (uma polegada) e a</p><p>terceira coluna possui 90 pontos</p><p>6 cm;0;6 cm A primeira coluna possui 6 (seis) centímetros, a segunda</p><p>coluna está oculta e a terceira coluna possui 6 (seis)</p><p>centímetros. Como parte da terceira coluna é visível, uma</p><p>barra de rolagem horizontal aparece</p><p>1,5 pol;0;2,5 pol A primeira coluna possui 1,5 polegadas, a segunda</p><p>coluna está oculta e a terceira coluna possui 2,5</p><p>polegadas</p><p>2 pol;;2 pol A primeira coluna possui 2 (duas) polegadas, a segunda</p><p>coluna possui 1 (uma) polegada (padrão) e a terceira</p><p>coluna possui 2 (duas) polegadas. Como somente</p><p>metade da terceira coluna é visível, uma barra de</p><p>rolagem horizontal aparece</p><p>(Vazio) Todas as três colunas possuem a mesma largura, ou 1,33</p><p>polegadas. O valor padrão desta propriedade é vazio,</p><p>ou seja, o Elipse E3 utiliza o valor padrão do sistema</p><p>Font</p><p>Esta propriedade é utilizada para determinar a fonte do objeto Lista. Esta propriedade não pode ser utilizada em</p><p>Associações e contém as subpropriedades descritas no tópico Fonte.</p><p>IMEMode</p><p>Esta propriedade especifica o modo IME (Input Method Editor) do objeto Lista.</p><p>Visualização</p><p>154</p><p>NOTA</p><p>Esta propriedade se aplica apenas a programas escritos em idiomas asiáticos (chinês simplificado, chinês tradicional,</p><p>coreano e japonês) e é ignorada em outros programas. Foi mantida por motivos de compatibilidade com a</p><p>especificação padrão dos objetos Microsoft Forms.</p><p>As opções disponíveis para esta propriedade estão descritas na tabela a seguir.</p><p>Opções disponíveis para a propriedade IMEMode</p><p>OPÇÃO DESCRIÇÃO</p><p>0 - fmIMEModeNoControl Não controla o modo IME (padrão)</p><p>1 - fmIMEModeOn Modo IME ativado</p><p>2 - fmIMEModeOff Modo IME desativado. Modo inglês</p><p>3 - fmIMEModeDisable Modo IME desativado. O usuário não pode ativar o</p><p>modo IME pelo teclado</p><p>4 - fmIMEModeHiragana Modo IME ativado com modo Hiragana de largura total</p><p>5 - fmIMEModeKatakana Modo IME ativado com modo Katakana de largura total</p><p>6 - fmIMEModeKatakanaHalf Modo IME ativado com modo Katakana de meia largura</p><p>7 - fmIMEModeAlphaFull Modo IME ativado com modo Alfanumérico de largura</p><p>total</p><p>8 - fmIMEModeAlpha Modo IME ativado com modo Alfanumérico de meia</p><p>largura</p><p>9 - fmIMEModeHangulFull Modo IME ativado com modo Hangul de largura total</p><p>10 - fmIMEModeHangul Modo IME ativado com modo Hangul de meia largura</p><p>11 - fmIMEModeHanziFull Modo IME ativado com modo Hanzi de largura total</p><p>12 - fmIMEModeHanzi Modo IME ativado com modo Hanzi de meia largura</p><p>IntegralHeight</p><p>Esta propriedade ajusta a altura da área de edição do texto, caso a área disponível ultrapasse o tamanho do</p><p>objeto. Se esta propriedade está configurada para Verdadeiro, a altura da área de edição do texto é reajustada para</p><p>coincidir com o tamanho atual do objeto, permitindo assim a exibição completa do conteúdo do texto. Caso contrário,</p><p>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</p><p>não é exibido no objeto.</p><p>List</p><p>Retorna ou define as entradas da linha e da coluna na lista do objeto. A numeração de linha e de coluna começa</p><p>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 é</p><p>0 (zero). O número da segunda linha ou coluna é 1 (um), e assim por diante. Esta propriedade não pode ser alterada</p><p>com o objeto ativo.</p><p>ListCount</p><p>Retorna o número de itens contidos na lista do objeto. Esta propriedade é somente de leitura.</p><p>ListIndex</p><p>Identifica o item atualmente selecionado na lista, chamado de índice. Os valores desta propriedade vão de -1</p><p>(menos um) ao número total de linhas em uma lista menos um, isto é, o valor da propriedade ListCount menos 1</p><p>(um). Quando nenhuma linha é selecionada, esta propriedade retorna -1 (menos um). Quando o usuário seleciona uma</p><p>linha em uma Lista de Seleção, o sistema define o valor desta propriedade. O valor desta propriedade da primeira</p><p>linha de uma lista é 0 (zero), o valor da segunda linha é 1 (um), e assim por diante. Esta propriedade não pode ser</p><p>alterada com o objeto ativo.</p><p>ListStyle</p><p>Esta propriedade determina o estilo da lista do objeto. Os valores possíveis para esta propriedade são 0 -</p><p>fmListStylePlain: Listagem com os itens do plano de fundo em destaque (padrão) ou 1 - fmListStyleOption: Exibe</p><p>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</p><p>155</p><p>Visualização</p><p>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</p><p>desmarcados.</p><p>NOTA</p><p>A opção 1 - fmListStyleOption só pode ser habilitada se a propriedade MultiSelect está configurada com o valor 1</p><p>- fmMultiSelectMulti.</p><p>Locked</p><p>Esta propriedade habilita ou desabilita a edição do objeto. Se esta propriedade está configurada para Verdadeiro,</p><p>a edição não é permitida. Caso contrário, é possível editar o objeto. Os valores configurados na propriedade Enabled</p><p>influenciam o comportamento desta propriedade. Para mais detalhes, consulte a propriedade Enabled. O valor</p><p>padrão desta propriedade é Falso.</p><p>MatchEntry</p><p>Procura, através do texto digitado pelo usuário, por uma entrada de texto que coincida com os dados existentes</p><p>no objeto. Ao encontrar uma coincidência no texto, a linha é selecionada e o conteúdo da coluna é exibido. Os valores</p><p>possíveis para esta propriedade são 0 - fmMatchEntryFirstLetter: Procura pela entrada de texto que coincida com o</p><p>primeiro caractere digitado no objeto. Se a mesma letra é digitada repetidamente, passa para a próxima entrada de</p><p>texto que comece com esta letra, e assim por diante (padrão), 1 - fmMatchEntryComplete: Conforme cada caractere</p><p>é digitado, o objeto procura por uma entrada de texto que coincida com os caracteres digitados ou 2 -</p><p>fmMatchEntryNone: Não realiza a procura no objeto.</p><p>MultiSelect</p><p>Esta propriedade indica se o objeto permite múltiplas seleções. Os valores possíveis para esta propriedade são 0 -</p><p>fmMultiSelectSingle: Somente um item pode ser selecionado (padrão), 1 - fmMultiSelectMulti: Permite selecionar</p><p>um item através da barra de espaço ou clique do mouse, permitindo que se marque ou desmarque um item</p><p>script a seguir no evento Click de um Botão de Comando.</p><p>Sub CommandButton1_Click()</p><p>Parent.Item("XControl11").Propriedade1 = True</p><p>End Sub</p><p>No caso de um XFolder ou XObject, deve-se inseri-lo em um Servidor de Dados, conforme o exemplo da figura a</p><p>seguir.</p><p>Exemplo de XObject</p><p>Para alterar a propriedade Valor do XObject, use o script a seguir.</p><p>Programando no Elipse E3</p><p>22</p><p>Sub CommandButton1_Click()</p><p>Application.GetObject("Dados.XObject11").Valor = 123</p><p>End Sub</p><p>Ou ainda o script a seguir.</p><p>Sub CommandButton1_Click()</p><p>Application.GetObject("Dados").Item("XObject11").Valor = 123</p><p>End Sub</p><p>Pode-se ainda ter um XControl acessando um XFolder ou XObject, através de uma XProperty. Por exemplo, a figura a</p><p>seguir mostra um XControl chamado XControl1 que possui uma propriedade XValor do tipo XObject1, que é o</p><p>nome do XObject criado.</p><p>XObject</p><p>XControl</p><p>Cria-se, por exemplo, uma Associação do valor do objeto Texto1 com a propriedade Valor do XObject1. Isso é</p><p>realizado através da propriedade XValor, criada no XControl1. Assim, o valor da propriedade Valor do XObject1 é</p><p>mostrada no objeto Texto1 do XControl1.</p><p>23</p><p>Programando no Elipse E3</p><p>Propriedade Valor</p><p>No projeto, o vínculo da instância XObject11 à instância XControl11 pode ser realizado através de uma Associação</p><p>na propriedade XValor.</p><p>Associação na Propriedade XValor</p><p>2.3.8.1 Exemplo de Criação de um ElipseX</p><p>Suponha que determinada aplicação necessite supervisionar e comandar 10 motores. Cada motor precisa ser</p><p>representado por um desenho na Tela, que exibe a cor verde quando em operação e vermelho quando desligado.</p><p>Também deve ser permitido o comando do motor na Tela, enviando instruções para ligar e desligar, além de exibir a</p><p>velocidade.</p><p>Uma possibilidade é a criação de um XControl chamado MotorA com as propriedades Estado igual a Boolean e</p><p>Velocidade igual a Double, conforme a figura a seguir.</p><p>Programando no Elipse E3</p><p>24</p><p>Aba Design</p><p>Aba Propriedades</p><p>1. Para a indicação da cor, a propriedade OverrideFillColor do motor deve estar associada à propriedade Estado</p><p>do XControl, através de uma Associação Digital. Configure a propriedade OverrideFillMode para 2 - SolidFill.</p><p>2. Para exibir a velocidade, a propriedade Value do Display deve ser associada à propriedade Velocidade do</p><p>XControl.</p><p>3. O Botão Liga-Desliga troca o valor da propriedade Estado através de uma Associação Simples.</p><p>Note que:</p><p>· As Associações dentro da biblioteca são internas, e o formato é Nome_do_Controle.Nome_da_Propriedade</p><p>· O objeto, depois de inserido na Tela, deve ter estas propriedades associadas aos Tags verdadeiros, para cada</p><p>um dos motores</p><p>· Uma Associação de um Tag para a propriedade Estado tem que ser realizada para cada objeto MotorA</p><p>25</p><p>Programando no Elipse E3</p><p>Elipse E3 Viewer</p><p>Outra possibilidade, mais abrangente, utiliza um XObject para o motor. Desta forma, todas as informações relativas</p><p>aos motores residem em objetos que estão no servidor. Assim, pode-se construir vários tipos de interface para o</p><p>motor (XControls) que trazem do servidor, através do XObject, somente as informações necessárias.</p><p>Desta maneira, o objeto MotorA teria que ser modificado para apontar para um XObject, ao invés de declarar em si</p><p>mesmo todas as propriedades.</p><p>1. Crie um XObject chamado MotorADados e declare neste objeto as propriedades Estado e Velocidade.</p><p>2. Crie um XControl MotorA que possua apenas uma propriedade, chamada MeusDados, do tipo MotorADados.</p><p>3. MotorADados deve ser inserido em uma Pasta de Dados no servidor e corresponde a cada um dos motores.</p><p>MotorA, por sua vez, aponta para o MotorADados desejado, e não é necessária a criação de novos Tags.</p><p>Configuração no Editor do XObject</p><p>Configuração no Editor do XControl</p><p>4. A propriedade Estado, associada à propriedade OverrideFillColor do motor, seria MotorA.MeusDados.Estado.</p><p>5. A propriedade Velocidade, associada ao Display, seria MotorA.MeusDados.Velocidade.</p><p>Programando no Elipse E3</p><p>26</p><p>2.4 Acessando Objetos</p><p>Seguindo o conceito de encapsulamento de programação orientada a objetos, os métodos e propriedades são</p><p>associados aos objetos de origem. Isto significa que sempre se deve indicar o objeto do qual se está acessando o</p><p>método ou propriedade.</p><p>2.4.1 Propriedades</p><p>Para referenciar as propriedades de um objeto, deve-se usar o método GetObject. A sintaxe é a seguinte:</p><p>Application.GetObject("<objeto>").<propriedade></p><p>Neste caso, <objeto> é o nome do objeto e <propriedade> é o nome da propriedade, conforme o exemplo a seguir.</p><p>Application.GetObject("Dados.TempTanque2").Type</p><p>Para facilitar a digitação, é aconselhável sempre utilizar o AppBrowser, que já traz a sintaxe correta.</p><p>2.4.1.1 Propriedade Value</p><p>No Elipse E3, muitos objetos possuem uma propriedade em comum chamada Value. Neste caso específico, pode-se</p><p>acessar esta propriedade utilizando se o próprio nome do objeto, conforme o exemplo a seguir.</p><p>Button1 = False</p><p>Que é equivalente ao exemplo a seguir.</p><p>Button1.Value = False</p><p>2.4.2 Métodos</p><p>A sintaxe a seguir exemplifica a chamada de um método que não precisa de parâmetros.</p><p>Application.GetObject("<objeto>").<metodo></p><p>Neste caso, <objeto> é o nome do objeto e <metodo> é o nome do método.</p><p>Se o método aceita parâmetros, use a sintaxe a seguir.</p><p>Application.GetObject("<objeto>").<metodo>(<parametro>)</p><p>Neste caso, <parametro> é o parâmetro a ser passado para o método. Quando houver mais de um parâmetro, utilize</p><p>vírgulas para separá-los.</p><p>Se o método retorna um resultado, e for desejável guardá-lo, então os parâmetros devem ser colocados</p><p>obrigatoriamente entre parênteses, conforme o exemplo a seguir.</p><p><V> =Application.GetObject("<objeto>").<metodo>(<parametro>)</p><p>Neste caso, <V> é a variável que recebe o resultado do método.</p><p>2.5 Trabalhando com Coleções</p><p>Uma Coleção, ou Collection, é um objeto que gerencia um conjunto de objetos similares. Os objetos contidos em uma</p><p>coleção são referenciados por índices, semelhante à referência de arrays. Pode-se adicionar ou remover objetos</p><p>individuais de uma coleção, conforme o exemplo a seguir.</p><p>Sub CommandButton1_Click()</p><p>' Adiciona uma Pena no objeto E3Chart1</p><p>Screen.Item("E3Chart1").Pens.AddPen "Pena"</p><p>End Sub</p><p>Sub CommandButton2_Click()</p><p>' Remove a primeira Pena</p><p>Screen.Item("E3Chart1").Pens.Remove 0</p><p>End Sub</p><p>NOTA</p><p>O primeiro objeto em uma coleção possui o índice 1 (um).</p><p>Todas as coleções possuem uma propriedade em comum chamada Count, que é o número de objetos ou filhos</p><p>existentes, conforme o exemplo a seguir.</p><p>27</p><p>Programando no Elipse E3</p><p>Sub CommandButton1_Click()</p><p>' Mostra uma caixa de diálogo com o número de Penas</p><p>MsgBox Screen.Item("E3Chart1").Pens.Count</p><p>End Sub</p><p>2.5.1 Acessando Objetos com o Método Item</p><p>Toda coleção possui um método Item, que pode ser usado para acessar qualquer objeto dentro da coleção. Este</p><p>método aceita um parâmetro Item, que pode ser um número inteiro positivo ou o nome do objeto dentro da coleção.</p><p>O exemplo a seguir é um ajuste da cor da segunda Pena de um objeto E3Chart.</p><p>Sub CommandButton1_Click()</p><p>' Modifica a cor da segunda pena</p><p>Screen.Item("E3Chart1").Pens.Item(2).Color = RGB(212, 208, 20)</p><p>End Sub</p><p>O mesmo ajuste pode ser obtido com o exemplo a seguir.</p><p>Sub CommandButton1_Click()</p><p>' Modifica a cor da pena com nome "Pena2"</p><p>Screen.Item("E3Chart1").Pens.Item("Pena2").Color</p><p>= RGB(212, 208, 20)</p><p>End Sub</p><p>Os comandos anteriores são equivalentes, o primeiro indicando o índice da Pena na coleção e o segundo indicando o</p><p>nome da Pena.</p><p>2.6 Comando Set</p><p>O VBScript implementa o conceito de polimorfismo das linguagens orientadas a objeto, permitindo que uma variável</p><p>do tipo Variant assuma a forma de um objeto qualquer através do comando Set. Deste modo, a variável funciona</p><p>como um ponteiro para o objeto desejado, permitindo acessar os métodos e propriedades, conforme o exemplo a</p><p>seguir.</p><p>Sub CommandButton1_Click()</p><p>Set E3Chart = Screen.Item("E3Chart1")</p><p>E3Chart.Pens.Item(2).Color = RGB(212, 208, 20)</p><p>End Sub</p><p>Neste exemplo foi executada a mesma tarefa da seção anterior, porém a parte referente a como chegar até o objeto</p><p>específico havia sido omitida. Sem o comando Set, a mesma chamada teria que ser escrita conforme o exemplo a</p><p>seguir.</p><p>Screen.Item("E3Chart1").Pens.Item(2).Color = RGB(212, 208, 20)</p><p>Aparentemente não existe vantagem neste caso, pois pode-se realizar todo o procedimento em uma única linha de</p><p>código. Porém, se logo adiante no mesmo script outras operações forem necessárias, o processo se torna mais</p><p>simples e rápido se a chamada ao método Item não tiver sido colocada em todas as linhas.</p><p>Sub CommandButton1_Click()</p><p>'Exemplo ruim</p><p>Screen.Item("E3Chart1").Pens.Item(0).Color = RGB(212, 208, 20)</p><p>Screen.Item("E3Chart1").Pens.Item(1).Color = RGB(200, 208, 20)</p><p>Screen.Item("E3Chart1").Pens.Item(2).Color = RGB(100, 208, 20)</p><p>End Sub</p><p>Sub CommandButton2_Click()</p><p>'Exemplo melhor</p><p>Set Penas = Screen.Item("E3Chart1").Pens</p><p>Penas.Item(0).Color = RGB(212, 208, 20)</p><p>Penas.Item(1).Color = RGB(200, 208, 20)</p><p>Penas.Item(2).Color = RGB(100, 208, 20)</p><p>End Sub</p><p>2.7 E3Globals</p><p>O E3Globals é um módulo do Elipse E3 que contém métodos de uso global. Os métodos</p><p>GetCurrentWindowsUserName, GetLocalTime e GetLocalTimeUTC não podem ser utilizados em Associações,</p><p>somente em scripts. O restante dos métodos pode ser utilizado tanto em scripts quanto em Associações.</p><p>A forma de utilização destes métodos admite as sintaxes E3Globals.<método> ou simplesmente <método>, exceto</p><p>no caso do objeto Relatório de Seção, onde a sintaxe E3Globals.<método> é obrigatória.</p><p>https://learn.microsoft.com/pt-br/office/vba/api/overview/language-reference/set-statement</p><p>Programando no Elipse E3</p><p>28</p><p>2.7.1 Métodos</p><p>Esta seção contém informações sobre os métodos do módulo E3Globals.</p><p>2.7.1.1 BShl</p><p>BShl(Value, Bits)</p><p>Retorna o valor passado no parâmetro Value deslocado à esquerda o número de bits especificado no parâmetro Bits.</p><p>Este método retorna um erro caso o parâmetro Bits esteja fora da faixa permitida (entre zero e 31). Este método está</p><p>disponível tanto em Associações quanto em scripts.</p><p>NOTA</p><p>Este método permite passar um valor de 32 bits sem sinal, no intervalo entre zero e 4.294.967.296, no parâmetro</p><p>Value, mas o valor de retorno é sempre um valor de 32 bits com sinal, no intervalo entre -2.147.483.648 e</p><p>2.147.483.647. Caso seja utilizado um valor de ponto flutuante, somente a parte inteira deste valor é utilizada.</p><p>2.7.1.2 BShr</p><p>BShr(Value, Bits, [PreserveSign])</p><p>Retorna o valor passado no parâmetro Value deslocado à direita o número de bits especificado no parâmetro Bits.</p><p>Este método retorna um erro caso o parâmetro Bits esteja fora da faixa permitida (entre zero e 31). O parâmetro</p><p>PreserveSign é um Booleano que permite preencher ou não os bits à esquerda com uma cópia do bit de sinal. Se</p><p>omitido, preenche os bits à esquerda com zeros. Este método está disponível tanto em Associações quanto em</p><p>scripts.</p><p>NOTA</p><p>Este método permite passar um valor de 32 bits sem sinal, no intervalo entre zero e 4.294.967.296, no parâmetro</p><p>Value, mas o valor de retorno é sempre um valor de 32 bits com sinal, no intervalo entre -2.147.483.648 e</p><p>2.147.483.647. Caso seja utilizado um valor de ponto flutuante, somente a parte inteira deste valor é utilizada.</p><p>2.7.1.3 Choose</p><p>Choose(Index, Values)</p><p>Retorna um dos itens especificados em Values, baseado no parâmetro Index, iniciando em 0 (zero). Este método</p><p>retorna Null caso o valor de Index seja menor que 0 (zero) ou maior ou igual ao número de valores em Values. Este</p><p>método está disponível tanto em Associações quanto em scripts.</p><p>NOTA</p><p>Este método não propaga a qualidade nem a estampa de tempo dos valores. Se uma Associação contém a</p><p>expressão Choose(TagIndex, Tag1.Value, Tag2.Value, Tag3.Value), o resultado é o valor selecionado, porém com</p><p>qualidade Boa (192) e estampa de tempo atual. Para que estas informações sejam preservadas, é necessário</p><p>especificar somente o objeto, como por exemplo Choose(TagIndex, Tag1, Tag2, Tag3).</p><p>2.7.1.4 DwordToLong</p><p>DwordToLong(Value)</p><p>Converte um valor de 32 bits sem sinal, no intervalo entre zero e 4.294.967.296, passado no parâmetro Value para um</p><p>valor de 32 bits com sinal, no intervalo entre -2.147.483.648 e 2.147.483.647, no mesmo padrão de bits. Se o valor</p><p>estiver no intervalo entre zero e 2.147.483.647, o valor é retornado sem mudanças.</p><p>NOTA</p><p>Caso o valor passado no parâmetro Value seja um valor de ponto flutuante, somente a parte inteira deste valor é</p><p>utilizada.</p><p>29</p><p>Programando no Elipse E3</p><p>2.7.1.5 E3Format</p><p>E3Format(Value, [Format])</p><p>Formata a expressão em Value utilizando o formato especificado em Format. Este formato utiliza as mesmas definições</p><p>da propriedade Format de objetos Texto, Display e SetPoint. Se omitido, mostra a expressão em Value formatada</p><p>conforme as configurações de região e idioma do Windows. Este método está disponível tanto em Associações</p><p>quanto em scripts.</p><p>2.7.1.6 E3ProductString</p><p>E3ProductString()</p><p>Este método retorna uma String contendo o nome e a versão do componente onde é invocado, como por exemplo</p><p>"Elipse E3 6.7.234" ou "Elipse E3 (64-bits) 6.7.234".</p><p>2.7.1.7 E3ProductVersionBuild</p><p>E3ProductVersionBuild()</p><p>Este método retorna o número de build da versão do componente onde é invocado. Por exemplo, se a versão do</p><p>componente é a 6.7.234, este método retorna o valor 234.</p><p>2.7.1.8 E3ProductVersionMajor</p><p>E3ProductVersionMajor()</p><p>Este método retorna o número principal da versão do componente onde é invocado. Por exemplo, se a versão do</p><p>componente é a 6.7.234, este método retorna o valor 6.</p><p>2.7.1.9 E3ProductVersionMinor</p><p>E3ProductVersionMinor()</p><p>Este método retorna o número secundário da versão do componente onde é invocado. Por exemplo, se a versão do</p><p>componente é a 6.7.234, este método retorna o valor 7.</p><p>2.7.1.10 GetBit</p><p>GetBit(Value, BitIndex)</p><p>Retorna o valor (verdadeiro ou falso) do bit de Value especificado em BitIndex. Este método retorna um erro caso o</p><p>parâmetro BitIndex esteja fora da faixa permitida (entre zero e 31). Este método está disponível tanto em Associações</p><p>quanto em scripts.</p><p>NOTA</p><p>Este método permite passar um valor de 32 bits sem sinal, no intervalo entre zero e 4.294.967.296, no parâmetro</p><p>Value. Caso seja utilizado um valor de ponto flutuante, somente a parte inteira deste valor é utilizada.</p><p>2.7.1.11 GetComputerName</p><p>GetComputerName()</p><p>Retorna uma String contendo o nome do computador atual. Este método está disponível tanto em Associações</p><p>quanto em scripts.</p><p>2.7.1.12 GetCurrentWindowsUserName</p><p>GetCurrentWindowsUserName()</p><p>Retorna uma String contendo o nome do usuário logado no processo corrente. Este método não está disponível em</p><p>Associações, somente em scripts.</p><p>2.7.1.13 GetLocalTime</p><p>GetLocalTime()</p><p>Retorna a data e hora do computador local, com precisão de milissegundos e no fuso horário local. Este método não</p><p>está disponível em Associações, somente em scripts.</p><p>Programando no Elipse E3</p><p>30</p><p>2.7.1.14 GetLocalTimeUTC</p><p>GetLocalTimeUTC()</p><p>Retorna a data e hora do computador local,</p><p>com precisão de milissegundos e no fuso horário UTC (Tempo Universal</p><p>Coordenado). Este método não está disponível em Associações, somente em scripts.</p><p>2.7.1.15 IIf</p><p>IIf(Condition, ExprTrue, ExprFalse)</p><p>Retorna a expressão contida em ExprTrue se a condição avaliada em Condition é verdadeira, e a expressão contida em</p><p>ExprFalse se a condição avaliada é falsa. Este método está disponível tanto em Associações quanto em scripts.</p><p>NOTA</p><p>Este método não propaga a qualidade nem a estampa de tempo dos valores. Se uma Associação contém a</p><p>expressão IIf(Tag1.Value = 0, Tag2.Value, Tag3.Value), o resultado é o valor de Tag2 ou Tag3, porém com</p><p>qualidade Boa (192) e estampa de tempo atual. Para que estas informações sejam preservadas, é necessário</p><p>especificar somente o objeto, como por exemplo IIf(Tag1.Value = 0, Tag2, Tag3).</p><p>2.7.1.16 LongToDword</p><p>LongToDword(Value)</p><p>Converte um valor de 32 bits com sinal, no intervalo entre -2.147.483.648 e 2.147.483.647, passado no parâmetro Value</p><p>para um valor de 32 bits sem sinal, no intervalo entre zero e 4.294.967.296, no mesmo padrão de bits. Se o valor</p><p>estiver entre zero e 2.147.483.647, o valor é retornado sem mudanças.</p><p>NOTA</p><p>Caso o valor passado no parâmetro Value seja um valor de ponto flutuante, somente a parte inteira deste valor é</p><p>utilizada.</p><p>2.7.1.17 MsgBoxEx</p><p>MsgBoxEx(prompt, [buttons], [title], [PosX], [PosY])</p><p>Este método permite mostrar uma caixa de diálogo padrão do Windows e especificar a posição na tela. Os</p><p>parâmetros disponíveis neste método são os seguintes:</p><p>· prompt: Texto a ser mostrado na caixa de diálogo. O tamanho máximo deste texto é de aproximadamente 1024</p><p>caracteres, dependendo da largura dos caracteres usados. Para inserir quebras de linha no texto, separe as linhas</p><p>usando a função Chr do VBScript com os valores 10 (avanço de linha), 13 (retorno de carro) ou uma combinação</p><p>destes valores entre cada linha</p><p>· buttons: Uma expressão numérica opcional que representa a soma dos valores especificando a quantidade e o</p><p>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</p><p>deste parâmetro é 0 (zero), ou seja, mostra apenas o botão OK. Consulte a tabela a seguir para mais informações</p><p>sobre este parâmetro</p><p>· title: Texto opcional mostrado na barra de título da caixa de diálogo. Se este parâmetro é omitido, a caixa de</p><p>diálogo não mostra nenhum título</p><p>· PosX: Indica a posição, em pixels, da caixa de diálogo em relação à margem esquerda da janela. Caso este</p><p>parâmetro seja omitido, a respectiva coordenada da caixa de diálogo é centralizada na janela</p><p>· PosY: Indica a posição, em pixels, da caixa de diálogo em relação à margem superior da janela. Caso este</p><p>parâmetro seja omitido, a respectiva coordenada da caixa de diálogo é centralizada na janela</p><p>NOTA</p><p>Caso os valores indicados nos parâmetros PosX e PosY posicionem a caixa de diálogo fora da área visível da janela,</p><p>estes valores são ajustados automaticamente para garantir que a caixa de diálogo esteja visível.</p><p>Os valores possíveis para o parâmetro buttons estão descritos nas tabelas a seguir.</p><p>31</p><p>Programando no Elipse E3</p><p>Valores possíveis para tipos de botões</p><p>VALOR DESCRIÇÃO CONSTANTE NO VBSCRIPT</p><p>0 Mostra apenas o botão OK vbOKOnly</p><p>1 Mostra os botões OK e Cancelar</p><p>(Cancel)</p><p>vbOKCancel</p><p>2 Mostra os botões Abortar (Abort),</p><p>Repetir (Retry) e Ignorar (Ignore)</p><p>vbAbortRetryIgnore</p><p>3 Mostra os botões Sim (Yes), Não</p><p>(No) e Cancelar (Cancel)</p><p>vbYesNoCancel</p><p>4 Mostra os botões Sim (Yes) e Não</p><p>(No)</p><p>vbYesNo</p><p>5 Mostra os botões Repetir (Retry) e</p><p>Cancelar (Cancel)</p><p>vbRetryCancel</p><p>Valores possíveis para estilos de ícones</p><p>VALOR DESCRIÇÃO CONSTANTE NO VBSCRIPT</p><p>16 Mostra um ícone indicando uma</p><p>mensagem crítica</p><p>vbCritical</p><p>32 Mostra um ícone indicando uma</p><p>pergunta</p><p>vbQuestion</p><p>48 Mostra um ícone indicando uma</p><p>afirmação</p><p>vbExclamation</p><p>64 Mostra um ícone indicando uma</p><p>informação</p><p>vbInformation</p><p>Valores possíveis para botões padrão</p><p>VALOR DESCRIÇÃO CONSTANTE NO VBSCRIPT</p><p>0 Indica que o primeiro botão é o</p><p>padrão de retorno</p><p>vbDefaultButton1</p><p>256 Indica que o segundo botão é o</p><p>padrão de retorno</p><p>vbDefaultButton2</p><p>512 Indica que o terceiro botão é o</p><p>padrão de retorno</p><p>vbDefaultButton3</p><p>768 Indica que o quarto botão é o</p><p>padrão de retorno</p><p>vbDefaultButton4</p><p>Valores possíveis para tipos de janelas modais</p><p>VALOR DESCRIÇÃO CONSTANTE NO VBSCRIPT</p><p>0 Indica que o usuário deve responder</p><p>esta caixa de diálogo antes de</p><p>continuar trabalhando na aplicação</p><p>vbApplicationModal</p><p>4096 Indica que todas as aplicações estão</p><p>suspensas até que o usuário</p><p>responda esta caixa de diálogo</p><p>vbSystemModal</p><p>Este método retorna um valor numérico que representa o botão clicado na caixa de diálogo, conforme a tabela a</p><p>seguir.</p><p>Programando no Elipse E3</p><p>32</p><p>Valores de retorno do método MsgBoxEx</p><p>VALOR BOTÃO CONSTANTE NO VBSCRIPT</p><p>1 OK vbOK</p><p>2 Cancelar (Cancel) vbCancel</p><p>3 Abortar (Abort) vbAbort</p><p>4 Repetir (Retry) vbRetry</p><p>5 Ignorar (Ignore) vbIgnore</p><p>6 Sim (Yes) vbYes</p><p>7 Não (No) vbNo</p><p>2.7.1.18 OPCGetLimit</p><p>OPCGetLimit(Quality)</p><p>Retorna a informação de Limite de uma Qualidade OPC especificada no parâmetro Quality. Este método está</p><p>disponível tanto em Associações quanto em scripts. Os valores possíveis de retorno deste método são 0: Livre, 1:</p><p>Baixo, 2: Alto ou 3: Constante.</p><p>2.7.1.19 OPCGetQuality</p><p>OPCGetQuality(Quality)</p><p>Retorna a informação de Qualidade de uma Qualidade OPC especificada no parâmetro Quality. Este método está</p><p>disponível tanto em Associações quanto em scripts. Os valores possíveis de retorno deste método são 0: Ruim, 1:</p><p>Incerta, 2: Não utilizada ou 3: Boa.</p><p>2.7.1.20 OPCGetSubStatus</p><p>OPCGetSubStatus(Quality)</p><p>Retorna a informação de Substatus (de 0 a 15) de uma Qualidade OPC especificada no parâmetro Quality. Este</p><p>método está disponível tanto em Associações quanto em scripts. O Padrão OPC especifica os seguintes valores:</p><p>· Qualidade Boa:</p><p>· 0: Não especificado</p><p>· 1: Sobrescrita local</p><p>· Qualidade Ruim:</p><p>· 0: Não especificado</p><p>· 1: Erro de configuração</p><p>· 2: Não conectado</p><p>· 3: Falha no dispositivo</p><p>· 4: Último valor conhecido</p><p>· 5: Falha de comunicação</p><p>· 6: Fora de serviço</p><p>· Qualidade Incerta:</p><p>· 0: Não especificado</p><p>· 1: Último valor utilizável</p><p>· 4: Sensor não confiável</p><p>· 5: Unidade de engenharia excedida</p><p>· 6: Subnormal</p><p>2.7.1.21 OPCGetVendor</p><p>OPCGetVendor(Quality)</p><p>Retorna a informação de Reservado para o Fabricante (de 0 a 255) de uma Qualidade OPC especificada em Quality.</p><p>Este método está disponível tanto em Associações quanto em scripts.</p><p>33</p><p>Programando no Elipse E3</p><p>2.7.1.22 OPCIsBad</p><p>OPCIsBad(Quality)</p><p>Retorna verdadeiro se a Qualidade OPC é Ruim, ou falso caso contrário. Este método está disponível tanto em</p><p>Associações quanto em scripts.</p><p>2.7.1.23 OPCIsGood</p><p>OPCIsGood(Quality)</p><p>Retorna verdadeiro se a Qualidade OPC é Boa, ou falso caso contrário. Este método está disponível tanto em</p><p>Associações quanto em scripts.</p><p>2.7.1.24 OPCIsUncertain</p><p>OPCIsUncertain(Quality)</p><p>Retorna verdadeiro se a Qualidade OPC é Incerta, ou falso caso contrário. Este método está disponível tanto em</p><p>Associações quanto em scripts.</p><p>2.7.1.25 OPCMakeQuality</p><p>OPCMakeQuality(QualityFlag, [SubStatus], [Limit], [Vendor])</p><p>Retorna um novo valor de Qualidade OPC utilizando os valores passados nos parâmetros QualityFlag, SubStatus, Limit</p><p>e Vendor. Este método está disponível tanto em Associações quanto em scripts. Os valores possíveis para cada um</p><p>dos parâmetros são os seguintes:</p><p>· QualityFlag: Especifica a qualidade do valor</p><p>· 0: Ruim</p><p>· 1: Incerta</p><p>· 3: Boa</p><p>· SubStatus: Especifica o substatus do valor (entre 0 e 15, consulte o método OPCGetSubStatus para os valores</p><p>possíveis). Se este</p><p>parâmetro é omitido, assume o valor 0 (zero)</p><p>· Limit: Especifica o limite do valor. Se este parâmetro é omitido, assume o valor 0 (zero)</p><p>· 0: Livre</p><p>· 1: Baixo</p><p>· 2: Alto</p><p>· 3: Constante</p><p>· Vendor: Valor específico do fabricante (entre 0 e 255). Se este parâmetro é omitido, assume o valor 0 (zero)</p><p>2.7.1.26 OPCSetLimit</p><p>OPCSetLimit(Quality, Limit)</p><p>Modifica a informação de Limite de uma Qualidade OPC e retorna o valor modificado. Este método está disponível</p><p>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</p><p>3: Constante.</p><p>2.7.1.27 OPCSetQuality</p><p>OPCSetQuality(Quality, QualityFlag)</p><p>Modifica a informação de Qualidade de uma Qualidade OPC e retorna o valor modificado. Este método está</p><p>disponível tanto em Associações quanto em scripts. Os valores possíveis para o parâmetro QualityFlag são 0: Ruim, 1:</p><p>Incerta, 2: Não utilizada ou 3: Boa.</p><p>2.7.1.28 OPCSetSubStatus</p><p>OPCSetSubStatus(Quality, SubStatus)</p><p>Modifica a informação de Substatus de uma Qualidade OPC (de 0 a 15) e retorna o valor modificado. Este método</p><p>está disponível tanto em Associações quanto em scripts. O Padrão OPC especifica os seguintes valores:</p><p>· Qualidade Boa:</p><p>· 0: Não especificado</p><p>Programando no Elipse E3</p><p>34</p><p>· 1: Sobrescrita local</p><p>· Qualidade Ruim:</p><p>· 0: Não especificado</p><p>· 1: Erro de configuração</p><p>· 2: Não conectado</p><p>· 3: Falha no dispositivo</p><p>· 4: Último valor conhecido</p><p>· 5: Falha de comunicação</p><p>· 6: Fora de serviço</p><p>· Qualidade Incerta:</p><p>· 0: Não especificado</p><p>· 1: Último valor utilizável</p><p>· 4: Sensor não confiável</p><p>· 5: Unidade de engenharia excedida</p><p>· 6: Subnormal</p><p>2.7.1.29 OPCSetVendor</p><p>OPCSetVendor(Quality, Vendor)</p><p>Modifica a informação de Reservado para o Fabricante (de 0 a 255) de uma Qualidade OPC e retorna o valor</p><p>modificado. Este método está disponível tanto em Associações quanto em scripts.</p><p>2.7.1.30 SetBit</p><p>SetBit(Value, BitIndex, BitValue)</p><p>Ajusta o valor de Value (verdadeiro ou falso) do bit especificado em BitIndex para BitValue. Este método retorna um</p><p>erro caso o parâmetro BitIndex esteja fora da faixa permitida (entre zero e 31). Este método está disponível tanto em</p><p>Associações quanto em scripts.</p><p>NOTA</p><p>Este método permite passar um valor de 32 bits sem sinal, no intervalo entre zero e 4.294.967.296, no parâmetro</p><p>Value, mas o valor de retorno é sempre um valor de 32 bits com sinal, no intervalo entre -2.147.483.648 e</p><p>2.147.483.647. Caso seja utilizado um valor de ponto flutuante, somente a parte inteira deste valor é utilizada.</p><p>2.7.1.31 SourceTypeName</p><p>SourceTypeName(SourceType)</p><p>Retorna uma String com a descrição da Fonte de Medida ativa, ou seja, a propriedade ActiveSource dos objetos</p><p>Medida Analógica e Medida Discreta do Elipse Power e do Elipse Water. Este método está disponível tanto em</p><p>Associações quanto em scripts. Os valores possíveis para o parâmetro SourceType são:</p><p>· -1: String vazia</p><p>· 0: Fonte Ativa</p><p>· 1: SCADA</p><p>· 2: Operador</p><p>· 3: Centro de Comando</p><p>· 4: Faturamento</p><p>· 5: Calculada</p><p>· 6: Banco de Dados</p><p>· 100: Processador Topológico</p><p>· 101: Fluxo de Potência</p><p>· 102: Estimador de Estados</p><p>· 103: Descarte de Cargas</p><p>· 104: Modelagem de Cargas para Distribuição</p><p>· 105: Autorrecuperação</p><p>35</p><p>Programando no Elipse E3</p><p>· 106: Leitor Externo</p><p>NOTA</p><p>Caso o valor passado no parâmetro SourceType não esteja entre os valores possíveis, este método retorna a String</p><p>"???".</p><p>2.7.1.32 XQuery</p><p>XQuery(ContextObject, [strQuery], [pVarOutError])</p><p>Este método retorna o resultado de uma Consulta Hierarquia do Aplicativo como uma String no formato XML. O</p><p>parâmetro ContextObject corresponde ao objeto de início desta Consulta. O parâmetro strQuery corresponde ao script</p><p>a ser utilizado na Consulta. O parâmetro opcional de saída pVarOutError contém uma String detalhando o resultado</p><p>da execução deste método.</p><p>2.8 Eventos, Métodos e Propriedades Gerais dos Objetos</p><p>Esta seção contém informações sobre os eventos, métodos e propriedades gerais dos objetos.</p><p>2.8.1 Eventos</p><p>Eventos são ocorrências relacionadas a um objeto que permitem disparar ações programadas. Existem, basicamente,</p><p>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</p><p>digitar algo no teclado, a informação relevante pode ser a tecla pressionada, ou se o usuário apontar e clicar com o</p><p>mouse, a informação relevante pode ser a posição do cursor e o status dos botões. Os Eventos Internos são, por</p><p>exemplo, mudanças de valor de uma variável ou Tag na aplicação. Como o Tag pode ser associado a um dispositivo</p><p>externo, diz-se que os eventos internos podem ter associações físicas, como a mudança da temperatura de uma</p><p>câmara, por exemplo.</p><p>2.8.1.1 Variáveis de Evento</p><p>Variáveis de Evento são criadas quando um evento inicia. Para serem utilizadas, devem ser associadas a parâmetros</p><p>na chamada do script do evento. O exemplo a seguir é a chamada de um procedimento associado ao evento</p><p>KeyDown de AlgumObjeto.</p><p>Sub AlgumObjeto_KeyDown(KeyCode, Shift)</p><p>Note que a chamada contém as variáveis KeyCode e Shift. O Elipse E3 atribui valores a estas variáveis automaticamente</p><p>no momento da ocorrência do evento. Neste caso, KeyCode recebe o código da tecla pressionada e Shift recebe</p><p>Verdadeiro ou Falso, conforme a tecla SHIFT esteja pressionada ou não.</p><p>2.8.1.2 OnStartRunning</p><p>OnStartRunning()</p><p>Ocorre tão logo um objeto seja iniciado. No exemplo a seguir, Meses é um Tag Interno e utiliza este evento para</p><p>inicializar o vetor.</p><p>Sub Meses_OnStartRunning()</p><p>Value = Array("Janeiro", "Fevereiro", "Março", "Abril",_</p><p>"Maio", "Junho", "Julho", "Agosto", "Setembro", "Outubro",_</p><p>"Novembro", "Dezembro")</p><p>End Sub</p><p>NOTA</p><p>Para acessar este array, é necessário copiar a propriedade Value para uma variável local.</p><p>2.8.1.3 OnStopRunning</p><p>OnStopRunning()</p><p>Ocorre quando termina a execução de uma instância de um objeto. Utilize este evento para realizar operações de</p><p>finalização para um objeto. O script a seguir contém um exemplo de uso deste evento.</p><p>Sub TagInterno1_OnStopRunning()</p><p>' Quando finaliza o objeto TagInterno1</p><p>' atribui False ao TagInterno2</p><p>Set tag2 = Application.GetObject("Dados.TagInterno2")</p><p>Programando no Elipse E3</p><p>36</p><p>tag2.Value = False</p><p>End Sub</p><p>2.8.2 Métodos</p><p>Esta seção contém informações sobre os métodos comuns aos objetos do Elipse E3. Cada tópico mostra o nome do</p><p>método com os respectivos parâmetros, na sintaxe correta, e um exemplo de utilização.</p><p>2.8.2.1 Chamadas de Métodos</p><p>Muitos métodos pré-definidos possuem parâmetros, que podem ou devem ser passados na chamada do método.</p><p>Para isto, o VBScript possui uma regra que deve ser seguida. Se um método é utilizado em uma atribuição, os</p><p>parâmetros devem estar entre parênteses, como neste exemplo de chamada do método GetObject.</p><p>obj = Application.GetObject("dados.tag001")</p><p>Já se um método é chamado sozinho, deve-se retirar os parênteses, como neste exemplo de chamada do método</p><p>SetVariableValue.</p><p>Screen.Item("Consulta").SetVariableValue Valor, 12</p><p>Os parênteses usados nas citações de métodos neste documento servem apenas como indicativo para diferenciá-los</p><p>das propriedades. Nos scripts, deve-se seguir esta mesma regra.</p><p>2.8.2.2 Activate</p><p>Activate()</p><p>Ativa um objeto que está inativo no momento. O script a seguir contém um exemplo de uso deste método.</p><p>Sub CommandButton1_Click()</p><p>Dim obj, tag</p><p>Set obj = Application.GetObject("Dados")</p><p>' Cria um novo objeto e o desativa (False)</p><p>Set tag = obj.AddObject("DemoTag", False)</p><p>' Inicializa os parâmetros do novo objeto</p><p>tag.Name = "tag001"</p><p>tag.Type = 3</p><p>' Ativa o objeto (coloca em execução)</p><p>tag.Activate()</p><p>End Sub</p><p>NOTA</p><p>Ativar um objeto usando este</p>