Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
pluginbase.Attributes.ConfigAttribute Class Reference

Attribute that designates a configuration setting is needed for a specific plugin or component of the plugin More...

Inheritance diagram for pluginbase.Attributes.ConfigAttribute:

Public Member Functions

 ConfigAttribute (string name, string displayName, object dflt)
 
bool Is (Type t)
 
bool Is< T > ()
 

Properties

string Name [get]
 Gets the internal name of the plugin More...
 
string DisplayName [get]
 Gets the display name of the plugin More...
 
string Description [get, set]
 Gets or sets the description of the configuration item More...
 
object Default [get, set]
 Gets or sets the default value for the item More...
 
object[] ValidValues [get, set]
 Gets or sets all valid items that the config can be More...
 
bool HasValidValues [get]
 Gets a value indicating whether this instance has valid values. More...
 
Type Type [get, set]
 

Detailed Description

Attribute that designates a configuration setting is needed for a specific plugin or component of the plugin

Attribute: AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Class, AllowMultiple = true, Inherited = true)

Constructor & Destructor Documentation

pluginbase.Attributes.ConfigAttribute.ConfigAttribute ( string  name,
string  displayName,
object  dflt 
)
76  {
77  Name = name;
78  DisplayName = displayName;
79  Default = dflt;
80  }
object Default
Gets or sets the default value for the item
Definition: ConfigAttribute.cs:34
string Name
Gets the internal name of the plugin
Definition: ConfigAttribute.cs:16
string DisplayName
Gets the display name of the plugin
Definition: ConfigAttribute.cs:22

Member Function Documentation

bool pluginbase.Attributes.ConfigAttribute.Is ( Type  t)
83  {
84  return Type == t;
85  }
Type Type
Definition: ConfigAttribute.cs:56
88  {
89  return Is(typeof(T));
90  }
bool Is(Type t)
Definition: ConfigAttribute.cs:82

Property Documentation

object pluginbase.Attributes.ConfigAttribute.Default
getset

Gets or sets the default value for the item

The default.

string pluginbase.Attributes.ConfigAttribute.Description
getset

Gets or sets the description of the configuration item

The description.

string pluginbase.Attributes.ConfigAttribute.DisplayName
get

Gets the display name of the plugin

The display name.

bool pluginbase.Attributes.ConfigAttribute.HasValidValues
get

Gets a value indicating whether this instance has valid values.

true if this instance has valid values; otherwise, false.

string pluginbase.Attributes.ConfigAttribute.Name
get

Gets the internal name of the plugin

The name.

Type pluginbase.Attributes.ConfigAttribute.Type
getset
object [] pluginbase.Attributes.ConfigAttribute.ValidValues
getset

Gets or sets all valid items that the config can be

The valid values.


The documentation for this class was generated from the following file: