PFPluginSetting Class

Contains the definition of a plugin setting. Can be used on plugins' properties to qualify an editable setting.

Note: it requires a get/set property.

Inheritance Hierarchy

SystemObject
SystemAttribute
Packflow.PluginsPFPluginSetting

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

Syntax

Copy

[DataContractAttribute]
[KnownTypeAttribute(typeof(List<long>))]
[KnownTypeAttribute(typeof(PFPluginSettingIdValues))]
[KnownTypeAttribute(typeof(PFPluginSettingIdValue))]
[AttributeUsageAttribute(AttributeTargets.Property, AllowMultiple = false)]
public class PFPluginSetting : Attribute

The PFPluginSetting type exposes the following members.

Constructors

	Name	Description
	PFPluginSetting	Initializes a new instance of the PFPluginSetting class.
	PFPluginSetting(String, Object)	Initializes a new instance of the PFPluginSetting class.

Top

Properties

	Name	Description
	Choices	Gets the setting's possible values. Contains null if not applicable.
	DisplayName	Gets or sets the setting display name.
	MultiValues	Gets a value indicating whether multiple values can be chosen. Only applicable in Enum and Choices setting types.
	Name	Gets the setting name (property name on the Type).
	Type	Gets the setting type.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
	Value	Gets the setting value. Contains the default value if not an instance.

Top

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.)
	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. (Inherited from Object.)

Top

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.)

Top

Reference

Packflow.Plugins Namespace

SystemAttribute