IIsDataPlugin Methods

Stator | API Documentation

The IIsDataPlugin type exposes the following members.

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
See Also

Reference