IIsImportPluginGetUserInterfacePluginSettings Method

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

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

Return Value

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

Why do we need this property?
You might be writing an import plugin which requires the user to set certain parameters which they can only do through
a user interface. An example could be a setting which requires the user to specify a port number for outgoing network
activity. The user interface allows you to accomplish such a task by allowing the plugin to have its own user interface.

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.

Examples
This code extract shows how Stator casts the user interface (UserControl) for display on screen.
(Extracted from Stator.AFM)
Copy
var Interface = (UserControl)UserInterfacePluginSettings;
Interface.Dock = DockStyle.Fill;
panel_PluginSettings.Controls.Add(Interface);
See Also

Reference

IIsImportPlugin Interface
Stator.libPublic.ImportPlugins Namespace