Click or drag to resize

PFJobSetting Class

Represents a PFJob persistant setting (or parameter) Used for generic Job setting manipulation by the engine.
Inheritance Hierarchy
SystemObject
  Packflow.Core.JobsPFJobSetting

Namespace:  Packflow.Core.Jobs
Assembly:  MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
Syntax
C#
Copy
[KnownTypeAttribute(typeof(PFJobSettingValue))]
[DataContractAttribute]
public sealed class PFJobSetting

The PFJobSetting type exposes the following members.

Properties
  NameDescription
Public propertyAllowChoicesOnly
Gets a value indicating whether UI should accept proposed values only. (Use drop down mode).
Public propertyDescription
Gets the description of the setting.
Public propertyDisplayPropertyName
Gets the name of the property used for display when setting value is a complex object.
Public propertyGroupName
Gets the UI group name of the parameter.
Public propertyIsCollection
Gets a value indicating whether this instance is collection.
Public propertyParameterName
Gets the display name of the parameter.
Public propertySettingType
Gets the type of the setting. Represents the category of object this settings persists, not a .Net Type.
Public propertyTargetType
Gets the full type name of the target PFJob implementation class.
Public propertyValuePreview
Gets the actual value display preview. This property is not serialized.
Top
Methods
  NameDescription
Public methodAddNewValue
Instanciates a new setting value with provided object, and adds it to the collection of setting values.
Public methodAddValue
Adds a value to the setting.
Public methodClearValues
Clears all setting values.
Public methodGetValues
Gets the current setting values.
Public methodRemoveValue
Removes the provided value from the setting.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodAsT
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.)
Public Extension MethodEqualsAll
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.)
Public Extension MethodEqualsAny
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.)
Public Extension MethodGetString
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.)
Public Extension MethodIsGenericListOverloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.)
Public Extension MethodIsGenericList(Type)Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.)
Public Extension MethodSerializeOverloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerialize(String)Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerializeJsonOverloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(ListType)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(DataContractJsonSerializerSettings)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Top
Remarks
Developers don't normally need this class to manipulate typed PFJob implementations. They may directly set properties declared as settings on the PFJob like any standard .Net property. The engines translates the Job instance's properties into settings when necessary.
Examples
See Also