Click or drag to resize

ExportEngine Class

Export engine for exporting data from Commence.
Inheritance Hierarchy
SystemObject
  Vovin.CmcLibNet.ExportExportEngine

Namespace:  Vovin.CmcLibNet.Export
Assembly:  Vovin.CmcLibNet (in Vovin.CmcLibNet.dll) Version: 1.0.7729.42686
Syntax
Copy
public class ExportEngine : IExportEngine, 
	IExportEngineEvents

The ExportEngine type exposes the following members.

Constructors
  NameDescription
Public methodExportEngine
Constructor.
Top
Properties
  NameDescription
Public propertySettings
Controls the export settings.
Top
Methods
  NameDescription
Public methodClose
Not needed, does nothing.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExportCategory(String, String, IExportSettings)
Export a category.
Public methodExportCategory(String, IEnumerableICursorFilter, String, IExportSettings)
Export a filtered category.
Public methodExportView
Export a view.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHandleExportCompleted
Event handler for the ExportCompleted event
Public methodHandleExportProgressChanged
Event handler for the ExportProgressChanged event.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventExportCompleted
ExportCompleted event raised when Commence data reading has completed.
Public eventExportProgressChanged
ExportProgressChanged event raised when (batch of) Commence data has been read.
Top
Remarks

Please note: the export engine tries to treat connected items as separate entities where possible - it is one of its core features. It relies on delimiters baked into the Commence API (either newline \n (not \r\n!) or a comma, depending on the situation.). The Commence Text field, when set to Large, and the URL field *can* contain embedded newline characters. When exporting those field-types, you may get unexpected results if they do. In that case you options are either to simply not include them in your export, or to disable the splitting of connected items.

Usage: .NET users can simply create an instance, COM clients can instantiate this by using the ProgId CmcLibNet.Export. VBScript example:

VBScript
Copy
Dim export : Set export = CreateObject("CmcLibNet.Export")
            '.. do stuff ..
Notice that contrary to e.g. ICommenceCursor or ICommenceDatabase, the IExportEngine does not require explicit closing.

See Also