COM object EvApplication

The EvApplication object represents the Echoview program. It contains methods and properties to access information about the running instance of Echoview and the EV files that are open.

View the Echoview COM object hierarchy and the Echoview summary of COM objects.

Use EvApplication to access Echoview via COM. All Echoview’s COM automation functionality is begun through this object. Refer to Scripting with COM objects - Creating a script.

The following Evapplication methods and properties are detailed below:

Methods

Properties: Collections, Classes and Members

NewFile
OpenFile
CloseFile
IsLicensed
Quit
GetLastLogMessage
Log
Minimize
Restore
BringToFront

EvFiles
Version
LogFileName

EvApplication implements the following methods and properties:

EvApplication methods

Description

NewFile

EvFile NewFile(string Filename)

Summary

Creates a new EV file and returns the EvFile object for it.

Parameters

Filename.

An optional parameter, used for specifying a template file.

Return

A COM object referring to the newly created document.

Note: If a template file is specified, this method will first check for a user specified Templates folder path. If unsuccessful the method will check the default path for the Templates folder.

OpenFile

EvFile OpenFile(string FileName)

Summary

Opens an EV file and returns the EvFile object for it.

Parameters

FileName

The path to an existing file to open.

Return

A COM object referring to the newly opened document.

CloseFile

CloseFile(EvFile FileName)

Summary

Closes an open EV file. Closes the file connected to the EvFile object.

Parameters

The EvFile object that refers to the EV file to be closed.

Return

None.

 

See also: EvFile.Close.

IsLicensed

boolean IsLicensed()

Summary

Returns a boolean to indicate whether or not Echoview is licensed for automation.

Parameters

None.

Return

True if Echoview has the required modules for COM automation licensed, false if not.

Quit

Quit()

Summary

Closes the connected instance of Echoview.

Parameters

None.

Return

None.

GetLastLogMessage

string GetLastLogMessage()

Summary

Returns the last message logged by Echoview. Useful after a method fails.

Parameters

None.

Return

The last message.

Note: See also Scripting errors.

Log

boolean Log(string Message)

Summary

Adds a message to the Echoview log.

Parameters

The message to log and the Echoview message bar.

Return

Whether successful.

Note: See also Scripting errors.

Minimize

Minimize()

Summary

Minimizes the Echoview window.

Restore

Restore()

Summary

Restores the Echoview window to the state it was in prior to Minimize().

BringToFront

BringToFront()

Summary

Attempts to bring the Echoview window to the front of the user's workspace; this will restore the window if it has been minimized.

However it may not actually bring the window to the front, and just flash the Echoview Taskbar button (this is a feature of Windows, to prevent an active application from changing without user intervention).

 

EvApplication properties

Description

EvFiles

EvFiles[]

Summary

Read-only EvFilesCollection object containing a reference to an EV file for each open document.

This is used for iterating through all open EV files or for searching for an open EV file by file name.

Version

Version

Summary

A string representation of Echoview’s version number.

Read-only

LogFileName

(read-write) string LogFileName

Summary

The name of the file that the log is written to.

Refer to Creating a script for an example of this property's usage.

Note: See also Scripting errors.

Example usage

To connect to Echoview, first create an instance of the EvApplication object:

' Open Echoview (if Echoview is already open, connects to the 
   ' open Echoview instance)
   Dim EvApp 
   Set EvApp = CreateObject("EchoviewCom.EvApplication") 

Once done, you can use this object to find information about Echoview or to create, open or access EV files:

' Shows what version of Echoview is running
   MsgBox EvApp.Version 
' Open an EV file 
  Dim MyFile 
  Set MyFile = EvApp.OpenFile("c:\Example.EV") 

See also

Scripting with COM objects
Getting started with scripting