IIsDataPlugin 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 data plugin

Namespace:  Stator.libPublic.DataPlugins
Assembly:  libPublic (in libPublic.dll) Version: 4.0.2018.0 (4.0.18103)
Syntax
Copy
public interface IIsDataPlugin

The IIsDataPlugin type exposes the following members.

Properties
  NameDescription
Public propertyAuthor
The author of the plugin
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 the plugin (PNG format)
Public propertyImagePNG64x64
A 64x64 pixel image for the plugin (PNG format)
Public propertyName
The name for the plugin
Public propertyVersion
The version for the plugin
i.e. 4.0.18000
Top
Methods
  NameDescription
Public methodDisplayTheSuggestedItem
Display the suggested item within the item user interface
Public methodDispose
Disposal method
Public methodGetItemDataSourcePath
Return the filepath/URL/pointer to the items data
i.e. C:\Data\US Stock\GE.txt or www.online-data/us_stocks/GE etc
Public methodGetItemSettingsString_FromSettingsUserInterface
Builds the template settings string from the user interface
This is the opposite method to: SetItemSettingsUserInterface_FromSettingsString(Object, String)
Public methodGetTemplateSettingsString_FromSettingsUserInterface
Builds the template settings string from the user interface
This is the opposite method to: SetTemplateSettingsUserInterface_FromSettingsString(Object, String)
Public methodCode exampleGetUserInterfaceItemSettings
A user interface which allows a user to set settings for an individual item (ticker, currency, basetype)
i.e. the 'forItem' (ticker or system exchange rate)
object = System.Windows.Forms.UserControl
Public methodCode exampleGetUserInterfaceTemplateSettings
A user interface which allows a user to set settings for a data template which uses this plugin
object = System.Windows.Forms.UserControl
Public methodInitialize
Initialize method
Public methodSetItemSettingsUserInterface_FromSettingsString
Populates the item settings user interface from the settings string provided
This is the opposite method to: GetItemSettingsString_FromSettingsUserInterface(Object)
Public methodSetTemplateSettingsUserInterface_FromSettingsString
Populates the template settings user interface from the settings string passed in
This is the opposite method to: GetTemplateSettingsString_FromSettingsUserInterface(Object)
Public methodSuggestItem
Suggest a data file/location for the passed in template settings, identifier and basetype
This is used to automatically return a "suggested" data file/location
Public methodSuggestItemAndReturnItemSettings
Suggest a data file/location for the passed in template settings, identifier and basetype
This will return an item settings string which Stator will persist to the database for the item
Top
Remarks

Why is this interface required?
If you want to write a data plugin you must implement this interface. In addition to implementing
this interface you will need to give your data plugin some functionality, this can be done by implementing
one of the following interfaces:

ISupportCharting
ISupportHistorical
ISupportLatest

Examples
This code extract shows the constructor for the pgnMetastock.dll data plugin implementation of IIsDataPlugin
(Extracted from pgnMetastock.dll (data plugin))
Copy
public DataPlugin()
{
    ID = "MSTOCK";
    Name = "pgnMetastock";
    Version = "4.0.18000";
    Author = "Anfield Capital Pty Ltd";
    Description = "Metastock data plugin for Stator-AFM";
    UserInterfaceTemplateSettings = new TemplateSettingsUserInterface();
    UserInterfaceItemSettings = new ItemSettingsUserInterface();
    ImagePNG16x16 = _Graphics.Metastock_Small;
    ImagePNG64x64 = _Graphics.Metastock_Large;
}
See Also

Reference

Stator.libPublic.DataPlugins Namespace