Class
FindParamCollection

Class to manage a collection of FindParam objects.

Definition

Namespace:ArtOfTest.WebAii.ObjectModel

Assembly:ArtOfTest.WebAii.dll

Syntax:

cs-api-definition
[Obsolete("Please use the FindExpression.StringRepresentation as a simpler serialization mechanizm or the FindExpressionsCollection<T>")]
public class FindParamCollection : Dictionary<string, FindParam>, IDictionary<string, FindParam>, ICollection<KeyValuePair<string, FindParam>>, IDictionary, ICollection, IReadOnlyDictionary<string, FindParam>, IReadOnlyCollection<KeyValuePair<string, FindParam>>, IEnumerable<KeyValuePair<string, FindParam>>, IEnumerable, IDeserializationCallback, IXmlSerializable, ISerializable

Inheritance: objectDictionary<string, FindParam>FindParamCollection

Implements: ICollectionICollection<KeyValuePair<string, FindParam>>IDeserializationCallbackIDictionaryIDictionary<string, FindParam>IEnumerableIEnumerable<KeyValuePair<string, FindParam>>IReadOnlyCollection<KeyValuePair<string, FindParam>>IReadOnlyDictionary<string, FindParam>ISerializableIXmlSerializable

Inherited Members Dictionary<string, FindParam>.Add(string, FindParam)Dictionary<string, FindParam>.Clear()Dictionary<string, FindParam>.ContainsKey(string)Dictionary<string, FindParam>.ContainsValue(FindParam)Dictionary<string, FindParam>.GetEnumerator()Dictionary<string, FindParam>.GetObjectData(SerializationInfo, StreamingContext)Dictionary<string, FindParam>.OnDeserialization(object)Dictionary<string, FindParam>.Remove(string)Dictionary<string, FindParam>.TryGetValue(string, out FindParam)Dictionary<string, FindParam>.ComparerDictionary<string, FindParam>.CountDictionary<string, FindParam>.KeysDictionary<string, FindParam>.ValuesDictionary<string, FindParam>.this[string]

Constructors

FindParamCollection()

Create a new FindParam collection that also be serialized.

Declaration

cs-api-definition
public FindParamCollection()

FindParamCollection(SerializationInfo, StreamingContext)

Create new FindParamCollection. Serialization Constructor

Declaration

cs-api-definition
public FindParamCollection(SerializationInfo info, StreamingContext context)

Parameters

info

SerializationInfo

Serialization info

context

StreamingContext

Serialization context

Properties

ReturnNullIfNotFound

Gets/Sets whether to throw or return null if a FindParam is not found.

Declaration

cs-api-definition
public bool ReturnNullIfNotFound { get; set; }

Property Value

bool

this[string]

Access a FindParam using its key.

Declaration

cs-api-definition
public FindParam this[string key] { get; }

Parameters

key

string

The key.

Property Value

FindParam

The FindParam object.

Methods

Add(string, FindParam)

Add a new FindParam item.

Declaration

cs-api-definition
public void Add(string key, FindParam param)

Parameters

key

string

The key.

param

FindParam

The FindParam object.

GetSchema()

Return the schema used for serialization. Currently we are returning null

Declaration

cs-api-definition
public XmlSchema GetSchema()

Returns

XmlSchema

The schema

Implements IXmlSerializable.GetSchema()

LoadFromFile(string)

Load a FindParamCollection from a file.

Declaration

cs-api-definition
public static FindParamCollection LoadFromFile(string fileName)

Parameters

fileName

string

The file name to load the xml from.

Returns

FindParamCollection

The FindParamCollection object.

LoadFromXml(string)

Load a FindParamCollection from an xml persisted string.

Declaration

cs-api-definition
public static FindParamCollection LoadFromXml(string xml)

Parameters

xml

string

The string string.

Returns

FindParamCollection

The FindParamCollection object.

OnItemAdded(FindParamCollectionItemAddedEventArgs)

Trigger the ItemAdded event.

Declaration

cs-api-definition
public void OnItemAdded(FindParamCollectionItemAddedEventArgs item)

Parameters

item

FindParamCollectionItemAddedEventArgs

The event argument.

ReadXml(XmlReader)

Deserialized from the xmlReader and initialize the object

Declaration

cs-api-definition
public void ReadXml(XmlReader reader)

Parameters

reader

XmlReader

The reader.

Implements IXmlSerializable.ReadXml(XmlReader)

Save(string)

Serialized and saves the current collection to a file. You can later load that file using FindParamCollection.Load().

Declaration

cs-api-definition
public void Save(string fileName)

Parameters

fileName

string

The file name to save to.

ToArray()

Get an array of FindParam objects contained in this collection.

Declaration

cs-api-definition
public FindParam[] ToArray()

Returns

FindParam[]

The array.

ToXml()

Serialize and return the current FindParamCollection as a string. You can later use that string to create a FindParamCollection using the .Load().

Declaration

cs-api-definition
public string ToXml()

Returns

string

The serialized Xml that represents this object.

WriteXml(XmlWriter)

Serialize this object to the XmlWriter

Declaration

cs-api-definition
public void WriteXml(XmlWriter writer)

Parameters

writer

XmlWriter

The writer.

Implements IXmlSerializable.WriteXml(XmlWriter)

Events

ItemAdded

Occurs when a new items is added to this collection.

Declaration

cs-api-definition
public event EventHandler<FindParamCollectionItemAddedEventArgs> ItemAdded

Event Value

EventHandler<FindParamCollectionItemAddedEventArgs>