COM object EvExporter

EvApplication > EvFileCollection > EvFile > EvExportersCollection > EvExporter

 

View the COM map and the COM summary.

The EvExporter object enables you to get information about the exporter and use the exporter. Note, use the EvApplication.Exec method and the command interface exporter properties to script changes for Exporter Properties.

The EvFile.Exporters[] property lists all the exporters in an EV file and is an EvExportersCollection.

EvExporter methods and properties include:

 

Description

Export

Export(string FileNameAndPath)

Summary

Export the CSV output from the exporter to a specified file path.

Parameters
  • FileNameAndPath
  • Name of the file to export the exporter output.
Return

Whether successful.

Example

The EV file has two preconfigured exporters.

Option Explicit
' Start Echoview
Dim oEvApp: Set oEvApp = CreateObject("EchoviewCom.EvApplication")

' Open the Exporter sample EV file
Dim oEvFile: Set oEvFile = oEvApp.OpenFile ("YourEVfileURL.EV")

If oEvFile Is Nothing Then
    MsgBox "Failed to open EV file"
Else
   Dim vExporterCollection: Set vExporterCollection = oEvFile.Exporters
   MsgBox "Number of exporters in the EV file: "& vExporterCollection.Count
   
   'Finding the first item in the list
   Dim vExporteritem : Set vExporteritem = vExporterCollection.Item(0) 
   MsgBox "First exporter name is: "& vExporteritem.Name 
   
   'Finding the second exporter by name
   Dim vSecondExporter : Set vSecondExporter = vExporterCollection.FindByName("Sv integration domain regions")
   MsgBox "Second exporter name is: "& vSecondExporter.Name 
   
   'Delete second exporter
   vExporterCollection.Delete(vSecondExporter)
   MsgBox "Deleted second exporter, Number of exporters in the EV file is now: "& vExporterCollection.Count
   
   'Export from the first Exporter
   'Export the first ExporterSetings, Export type, and Notes
   vExporteritem.Export("C:\Data and EV files\AExport\FirstExporter.csv")
   vExporteritem.ExportSettings("C:\Data and EV files\AExport\FirstExporterSettings.csv")
   
   MsgBox "First exporter, Name, Type and notes : "& vExporteritem.Name &"  Export type enum is "& vExporteritem.ExportType &"  Notes  "& vExporteritem.Notes 
   
End If
MsgBox "Press Enter to end this example script, and close Echoview without saving."

 

See also: EvVariableAcoustic.AddExporter example.

ExportSettings

ExportSettings(string FileNameAndPath)

Summary

ExportSettings outputs a file that contains the exporter's properties as lists of tab-separated values. This is equivalent to the right-click menu item Export, Settings on the Dataflow window.

The header row is:

ObjectName PropertyName CurrentValue Units MinimumValue MaximumValue ValueOptions DefaultValue

Parameters
  • FileNameAndPath
  • Name and path for the output file.
Return

Whether successful.

Example

See Exporter example.

ExportType

(read-only) ExportType

Summary

Returns the EExportType enum for the export type of the exporter.

Parameters

None

Return

Whether successful.

Example

See Exporter example.

Name

string Name

Summary

Access the name of the exporter. Note, the use of Dynamic exporter property and a Dynamic name will lock Name property.

Parameters

None

Return

The return is the name of the exporter.

Example

See Exporter example.

Notes

string Notes

Summary

Get or add text from the Notes section of the exporter, as a string of characters.

Parameters

None

Return

The return is a string containing the exporter Notes text.

Example

See Exporter example.

See also

Scripting with COM objects
EvExportersCollection
COM object hierarchy