Click or drag to resize

ContextParameters Class

This class defines the WorkflowGen context. You can create a new one or use one from a DataSet or XML RecordSet Context. Various methods could be used to set or get parameters, also somme static methods are useful to convert a WorkflowGen Context.
Inheritance Hierarchy
SystemObject
  WorkflowGen.My.DataContextParameters

Namespace:  WorkflowGen.My.Data
Assembly:  WorkflowGen.My (in WorkflowGen.My.dll) Version: 3.4.0.0 (3.4.0.0)
Syntax
public class ContextParameters : IDisposable, 
	IEnumerable

The ContextParameters type exposes the following members.

Constructors
  NameDescription
Public methodContextParameters
Initialize to a blank RecordSet context
Public methodContextParameters(DataSet)
Initialize an instance with a DataSet object
Public methodContextParameters(String)
Initialize with an Json or XML RecordSet or DataSet
Public methodContextParameters(XmlDocument)
Creates WFG context from a XML document (RecordSet or DataSet XML Document)
Public methodContextParameters(ContextParametersContextFormat)
Initialize to a blank DataSet context
Top
Properties
  NameDescription
Public propertyCount
Counts the number of ParameterData contained into the collection
Public propertyItemInt32
Gets the data parameter associated with the specified index
Public propertyItemString
Gets the data parameter associated with the specified name
Top
Methods
  NameDescription
Public methodAdd
Adds a new data parameter to the collection
Public methodApplyFilter(Hashtable)
Filter the collection with parameters matching with the parameter criterias
Public methodApplyFilter(String, ContextParametersComparisonOperators)
Filter the collection with parameters matching with the name
Public methodApplyFilter(Type, ContextParametersComparisonOperators)
Filter the collection with parameters matching the data type
Public methodApplyFilter(ContextParameterDirections, ContextParametersComparisonOperators)
Filter the collection with parameters matching the direction
Public methodContains
Determines whether or not a data parameter identified by the given name exists into the collection
Public methodDispose
Frees resources and perform other operations before the Object is reclaimed by garbage collector.
Public methodGetEnumerator
Returns an enumerator that can iterate through the data parameters collection (non-IEnumerable version)
Public methodGetJson
Returns a JSON string representation of the collection
Public methodGetJson(String)
Returns a JSON string representation of the collection
Public methodGetXml
Returns the XML string representation of the collection, with the initial format received
Public methodGetXml(ContextParametersContextFormat)
Returns an XML string representation of the collection
Public methodInit
Reset and init the collection from the original context
Public methodRemove
Removes the data parameter identified by the given name from the collection
Public methodRemoveFilter
Remove all previous filters and restore the collection with the last updated values.
Public methodResetFilter
Reset all previous filters and restore the collection with the original context.
Public methodSave(String)
Save the current data parameters collection into an XML file
Public methodSave(String, ContextParametersContextFormat)
Save the current data parameters collection into an XML file
Public methodUpdate
Commits all the changes made to the parameters
Public methodUpdate(Int32)
Commits the changes made to the parameter specified by the index
Public methodUpdate(String)
Commits the changes made to the parameter specified by the name
Top
See Also