IIsImportPlugin Interface

Stator | API Documentation
Interface which identifies the assembly/file as a data plugin.
If you implement this interface, Stator will identify the assembly as a valid import plugin.

Namespace:  Stator.libPublic.ImportPlugins
Assembly:  libPublic (in libPublic.dll) Version: 4.0.2018.0 (4.0.18103)
Syntax

public interface IIsImportPlugin

The IIsImportPlugin type exposes the following members.

Properties

  NameDescription
Public propertyAuthor
The author of the plugin.
Public propertyCanCloseOpenPositions
Internally set this flag to true if the import plugin supports the closing of an open position data.
Public propertyCanImportCashAccounts
Internally set this flag to true if the import plugin supports cash account data.
Public propertyCanImportCashTransactions
Internally set this flag to true if the import plugin supports cash transaction data.
Public propertyCanImportClosedPositions
Internally set this flag to true if the import plugin supports closed position data.
Public propertyCanImportEstateDiaryNotes
Internaly set this flag to true if the import plugin supports estate diary note data.
Public propertyCanImportEstates
Internaly set this flag to true if the import plugin supports estate data.
Public propertyCanImportIncome
Internally set this flag to true if the import plugin supports imcome data, i.e. dividends, trust distributions.
Public propertyCanImportOpenPositions
Internally set this flag to true if the import plugin supports open position data.
Public propertyCredits
A string for credits/license information for the plugin.
Public propertyDescription
A brief description of the plugin.
Public propertyID
The ID for the plugin.
Public propertyImagePNG16x16
A 16x16 pixel image for this plugin (PNG format).
Public propertyImagePNG64x64
A 64x64 pixel image for this plugin (PNG format).
Public propertyName
The name for the plugin.
Public propertyVersion
The version for the plugin.
i.e. 4.0.1800
Top
Methods

  NameDescription
Public methodClear
Clear/reset the plugin.
Public methodDispose
Disposal method.
Public methodGetSettingsString_FromUserInterface
Return a settings string from the user interface settings.
Public methodCode exampleGetUserInterfacePluginSettings
A user interface which allows a user to set settings for a data template which uses this plugin (if applicable).
object = System.Windows.Forms.UserControl
Public methodInitialize
Initialize method.
Public methodReadData(IListIPluginError)
Read import data.
This will use the settings as set in the plugin user interface.
Public methodReadData(String, IListIPluginError)
Read import data using the settings string.
This method uses the settings string passed in.
Public methodSetUserInterface_FromSettingsString
Populate the user interface with the settings passed into the method in string form.
Top
See Also

Reference