Class PluginConfig

Namespace

DotCompute.Plugins.Configuration

Assembly

DotCompute.Plugins.dll

Configuration for a specific plugin. Provides settings and metadata for plugin loading and initialization.

public class PluginConfig

Inheritance

object

PluginConfig

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This class contains all necessary information to configure and load a plugin, including assembly path, type information, and plugin-specific settings.

Properties

AssemblyPath

Gets or sets the plugin assembly path.

public string AssemblyPath { get; set; }

Property Value

string

The file system path to the plugin assembly. Cannot be null.

Remarks

This path is used to locate and load the plugin assembly. The path should point to a valid .NET assembly file.

Enabled

Gets or sets whether the plugin is enabled.

public bool Enabled { get; set; }

Property Value

bool

true if the plugin should be loaded and activated; otherwise, false. Default value is true.

Remarks

Disabled plugins are ignored during the plugin discovery and loading process. This allows for temporary disabling of plugins without removing their configuration.

Settings

Gets or sets plugin-specific settings.

public Dictionary<string, object> Settings { get; }

Property Value

Dictionary<string, object>

A dictionary containing key-value pairs of plugin configuration settings. Cannot be null.

Remarks

This dictionary contains arbitrary settings that are specific to the plugin. The plugin implementation can access these settings during initialization to customize its behavior.

TypeName

Gets or sets the plugin type name.

public string TypeName { get; set; }

Property Value

string

The fully qualified type name of the plugin class. Cannot be null.

Remarks

This should be the full type name including namespace of the class that implements the plugin interface.