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]
	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

ConfigAttribute()

pluginbase.Attributes.ConfigAttribute.ConfigAttribute	(	string	name,
		string	displayName,
		object	dflt
	)

        {
            Name = name;
            DisplayName = displayName;
            Default = dflt;
        }

Member Function Documentation

Is()

bool pluginbase.Attributes.ConfigAttribute.Is

(

Type

t

)

        {
            return Type == t;
        }

Is< T >()

bool pluginbase.Attributes.ConfigAttribute.Is< T >

(

)

        {
            return Is(typeof(T));
        }

Property Documentation

Default

object pluginbase.Attributes.ConfigAttribute.Default

get

Gets or sets the default value for the item

The default.

Description

string pluginbase.Attributes.ConfigAttribute.Description

getset

Gets or sets the description of the configuration item

The description.

DisplayName

string pluginbase.Attributes.ConfigAttribute.DisplayName

get

Gets the display name of the plugin

The display name.

HasValidValues

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.

Name

string pluginbase.Attributes.ConfigAttribute.Name

get

Gets the internal name of the plugin

The name.

Type

Type pluginbase.Attributes.ConfigAttribute.Type

getset

ValidValues

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:

• pluginbase/Attributes/ConfigAttribute.cs