IIsDataPluginGetUserInterfaceItemSettings Method

Stator | API Documentation
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

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

Object GetUserInterfaceItemSettings()

Return Value

Type: Object
An object to be cast to System.Windows.Forms.UserControl

Why do we need this property?
Sometimes a user will want to override template based settings with more specific settings related to a single item.
An example might a user wishing to return obtain data for security ABC but link this to XYZ, by allowing the user item
specific settings you give them a greater amount of control over the data file linked to the item. Of course that is
only one example of many possible item settings your could employ.

Why is this property of type "object"?
Internally we cast the object to type System.Windows.Forms.UserControl but have left the data type as object because
some of our own plugins (authored by Anfield Capital) use different user interface types.


This code extract shows how Stator casts the user interface (UserControl) for display on screen
(Extracted from Stator.AFM)
var Interface = (UserControl)UserInterfaceItemSettings;
Interface.Dock = DockStyle.Fill;
UI_Settings_Latest = Interface;
See Also