PluginAttribute

Overview

The PluginAttribute is a base class for a custom plugins attirubte. Hydra uses this attribute to locate plugins within assembly and to get access to meta-data. Every Hydra plugin must have a set of attributes to allow host application properly detect kind of a plugin.

Use Case

You can use this class to associate user-defined information, such as name of the plugin, description and some user data to the target visual or non-visual plugin.

  [Plugin(Name = "SamplePlugin", Description = "This is sample plugin", UserData = "Data"), VisualPlugin]
  public partial class Plugin1 : VisualPlugin
  [..]

Location


 

constructor

Creates a new instance of the class.

 

constructor

 

PluginAttribute()

 

Sub New()

Description

Gets or sets the description of the plugin.

 

property Description: String read write;

 

String Description { get; set; }

 

Property Description() As String

MajorVersion

 

property MajorVersion: Int32 read write;

 

Int32 MajorVersion { get; set; }

 

Property MajorVersion() As Int32

MinorVersion

 

property MinorVersion: Int32 read write;

 

Int32 MinorVersion { get; set; }

 

Property MinorVersion() As Int32

Name

Gets or sets the name of the plugin.

 

property Name: String read write;

 

String Name { get; set; }

 

Property Name() As String

RequiredPrivilege

 

property RequiredPrivilege: String read write;

 

String RequiredPrivilege { get; set; }

 

Property RequiredPrivilege() As String

UserData

Gets or sets the user data.

 

property UserData: String read write;

 

String UserData { get; set; }

 

Property UserData() As String

 

Description

Gets or sets the description of the plugin.

 

property Description: String read write;

 

String Description { get; set; }

 

Property Description() As String

MajorVersion

 

property MajorVersion: Int32 read write;

 

Int32 MajorVersion { get; set; }

 

Property MajorVersion() As Int32

MinorVersion

 

property MinorVersion: Int32 read write;

 

Int32 MinorVersion { get; set; }

 

Property MinorVersion() As Int32

Name

Gets or sets the name of the plugin.

 

property Name: String read write;

 

String Name { get; set; }

 

Property Name() As String

RequiredPrivilege

 

property RequiredPrivilege: String read write;

 

String RequiredPrivilege { get; set; }

 

Property RequiredPrivilege() As String

UserData

Gets or sets the user data.

 

property UserData: String read write;

 

String UserData { get; set; }

 

Property UserData() As String

 

constructor

Creates a new instance of the class.

 

constructor

 

PluginAttribute()

 

Sub New()