Interface IStonefieldQuerySetupPlugin

The interface that Setup plugins must implement.


public abstract interface IStonefieldQuerySetupPlugin

Remarks

Plugin classes implementing this interface must have an attribute that implements IStonefieldQuerySetupPluginMetaData.

Interface Members

MemberDescription

GetSettings

Gets the settings from whereever they're stored (configuration file, Windows Registry, etc.).

public Dictionary<String,Dictionary`2> GetSettings();

SaveSettings

public bool SaveSettings(Dictionary<String,Dictionary`2> settings);

public bool SaveSettings(Dictionary<String,Dictionary`2> settings)

Validate

public bool Validate(Dictionary<String,String> values);

public bool Validate(Dictionary<String,String> values)

AllowMultiple

True if multiple values are allowed. In that case, a list is displayed with add and remove buttons.

Caption

Custom settings appear in tabs in the setup dialog. This property specifies the caption for the tab.

Enabled

True if this plugin should be active.

NeedSetup

True if we need to get values for these settings from the user. This is typically true the first time a user launches the app, but not necessarily.

Settings

A list of the settings.

UserCanAddNewItems

True if the user can add new items to the items managed by this plugin.

Requirements

Namespace: Stonefield.Query.Plugins
Assembly: interfaces.dll