Collection Class

ComparisonName

Type: System.String

The generic type definition name of the collection. The Rule Editor uses this value to determine whether the collection can be compared with other collections defined in the Source, hence the name of this property. You can obtain this value from the type of your collection field, parameter, or return value by executing the following code:

  Type constructed = typeof(ICollection<MyType>).GetGenericTypeDefinition();
  var name = genericDef.FullName; // "System.Collections.Generic.ICollection`1"

DataType

Type: CodeEffects.Rule.Common.Models.DataType

The data type of the underlying class of the collection. This value should be only used in value-typed collections. The default value is DataType.None.

Example

  using CodeEffects.Rule.Common.Models;
  using CodeEffects.Rule.Editor.Client;

  // Field of List<string> type (value-typed collection)
  var field = new Field
  {
  	Value = "Student.Nicknames",
  	DisplayName = "List of nicknames of the student",
  	DataType = DataType.Collection,
  	Collection = new Collection
  	{
  		ComparisonName = "System.Collections.Generic.List`1",
  		DataType = DataType.String,
  		IsArray = false,
  		IsGeneric = true,
  		IsUnderlyingTypeNullable = true,
  		Type = CollectionType.Value,
  		UnderlyingTypeName = "System.String"
  	}
  };

UnderlyingTypeName

Type: System.String

The assembly-qualified name or alias of the collection's underlying type. This property is ignored for generic collections.

Example

  using CodeEffects.Rule.Common.Models;
  using CodeEffects.Rule.Editor.Client;

  // Field of List<Student> type (reference-typed collection)
  var field = new Field
  {
  	Value = "Student.Schools",
  	DisplayName = "List of schools attended by the student",
  	DataType = DataType.Collection,
  	Collection = new Collection
  	{
  		ComparisonName = "System.Collections.Generic.List`1",
  		DataType = DataType.None, // No data types in reference collections
  		IsArray = false,
  		IsGeneric = true,
  		DisplayName = "School",
  		IsUnderlyingTypeNullable = true,
  		Type = CollectionType.Reference, // Type of this collection - value, reference, or generic
  		UnderlyingTypeName = "TestProject.People.Student, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
  	}
  };