PFPluginDescription Class

Contains the description of a PFPlugin. Can be used on a plugin class to specify its general behavior.

Inheritance Hierarchy

SystemObject
SystemAttribute
Packflow.PluginsPFPluginDescription

Namespace: Packflow.Plugins
Assembly: MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)

Syntax

[DataContractAttribute]
[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false)]
public class PFPluginDescription : Attribute

The PFPluginDescription type exposes the following members.

Constructors

	Name	Description
	PFPluginDescription	Initializes a new instance of the PFPluginDescription class.
	PFPluginDescription(String, PFPluginInstancePattern, String)	Initializes a new instance of the PFPluginDescription class.

Properties

	Name	Description
	AssemblyName	Gets the name of the assembly hosting the plugin's class.
	Description	Gets or sets the plugin description.
	DisplayName	Gets or sets the plugin display name.
	InstanceGuid	Gets or sets the instance GUID. Contains Guid.Empty if not an instance.
	InstanceName	Gets or sets the instance Name. Contains String.Empty if not an instance.
	InstancePattern	Gets or sets the kind of instance are expected for the plugin
	InstancePriority	Gets or sets the instance priority number. Higher number means more priority. Default value: 1.
	Settings	Gets the plugin's settings, not recursive.
	SubPlugins	Gets the sub-plugins. Only relevant if this plugin is a bundle. Each object contains the sub plugin's description, the name of the property hosting the plugin from the bundle, and the display name for this instance (used in case of a bundle referencing a plugin type multiple times).
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
	TypeName	Gets the name of the type.

Methods

	Name	Description
	Equals	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetSubPlugin	Gets a sub plugin. The filter is not case sensitive.
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)

Extension Methods

	Name	Description
	AsT	Casts an object to another type. Returns default(T) if the object is null. (Defined by Utils_Other.)
	EqualsAll	Checks that this object is equal to every object in parameters. (Defined by Utils_Other.)
	EqualsAny	Checks that this object is equal to at least one of the parameters. (Defined by Utils_Other.)
	GetString	Converts an object to String using ToString() method, else returns String.Empty. (Defined by Utils_Other.)
	IsGenericList	Overloaded. Checks if this object is a System.Collections.Generic.List. (Defined by Utils_Linq.)
	IsGenericList(Type)	Overloaded. Checks if this object is a System.Collections.Generic.List using type as T. (Defined by Utils_Linq.)
	Serialize	Overloaded. Serializes an object into an XML document. (Defined by Utils_Xml.)
	Serialize(String)	Overloaded. Serializes an object into an XML document. (Defined by Utils_Xml.)
	SerializeJson	Overloaded. Serializes an object using a DataContractJsonSerializer. (Defined by Utils_String.)
	SerializeJson(ListType)	Overloaded. Serializes an object using a DataContractJsonSerializer. (Defined by Utils_String.)
	SerializeJson(DataContractJsonSerializerSettings)	Overloaded. Serializes an object using a DataContractJsonSerializer. (Defined by Utils_String.)