Collection

All

Takes a list of objects and returns TRUE if each objects meets the specified condition.

Syntax

All ( Objects , ObjectName , Condition )

Parameters

Objects List of objects which will be evaluated. Type: List<Any>

ObjectName Variable Name to identify the object in the condition. Type: String

Condition Condition used to evaluate the list. Type: Boolean

Return Type

Boolean

Any

Takes a list of objects and a determines whether one or more of the items meets a specified condition.

Syntax

Any ( Objects [, ObjectName] [, Condition] )

Parameters

Objects List of objects which will be evaluated. Type: List<Any>

ObjectName (optional) Variable Name to identify the object in the condition. Type: String

Condition (optional) Condition used to evaluate the list. Type: Boolean

Return Type

Boolean

Count

Takes a list of objects and returns the number of objects in that list.

Syntax

Count ( List )

Parameters

List List of objects to count. Type: List<Any>

Return Type

Int

Distinct

Takes a list of objects and a selection criteria as input and and selects by a specified criteria if objects are different. Returns a list of those distinct values.

Syntax

Distinct ( Objects [, ObjectName] [, Selection] )

Parameters

Objects The list of objects which will be examined. Type: List<Any>

ObjectName (optional) Variable Name to identify the object in the condition. Type: String

Selection (optional) Selection Criteria. Type: Any

Return Type

List<Any>

ElementAt

Takes a list of Objects and returns the object at the given Index.

Syntax

ElementAt ( Objects , Index )

Parameters

Objects The list of Objects to get the object from. Type: List<Any>

Index The Index of the Object to get. Type: Int

Return Type

Any

First

Takes a List of Objects and returns the first value which satisfies the condition. If no condition is specified, it returns the first object. It returns null, if no item can be found.

Syntax

First ( Objects [, ObjectName] [, Condition] )

Parameters

Objects List of objects used as basis for the operation. Type: List<Any>

ObjectName (optional) Variable Name to identify the object in the condition. Type: String

Condition (optional) Condition used to evaluate the list. Type: Boolean

Return Type

Any

GetGroupKey

Gets the Key of a Group (created by GroupBy).

Syntax

GetGroupKey ( Group )

Parameters

Group The Group to get the Key from. Type: List<Any>

Return Type

Any

GroupBy

Takes a list of Objects and groups them by value retrieved by the Selection criteria.

Syntax

GroupBy ( Objects , ObjectName , Selection )

Parameters

Objects The list of Objects to Group. Type: List<Any>

ObjectName Variable Name to identify the object in the Selection criteria. Type: String

Selection The Selection criteria. Type: Any

Return Type

List<Group>

Last

Takes a List of Objects and returns the last value which satisfies the condition. If no condition is specified, it returns the last object. It returns null, if no object is found.

Syntax

Last ( Objects [, ObjectName] [, Condition] )

Parameters

Objects List of objects used as basis for the operation. Type: List<Any>

ObjectName (optional) Variable Name to identify the object in the condition. Type: String

Condition (optional) Condition used to evaluate the list. Type: Boolean

Return Type

Any

Many

Takes a list of Objects as input and determines, if the list which is filtered by a condition, contains more than one item.

Syntax

Many ( Objects [, ObjectName] [, Condition] )

Parameters

Objects List of objects which will be evaluated. Type: List<Any>

ObjectName (optional) Variable Name to identify the object in the condition. Type: String

Condition (optional) Condition used to evaluate the list. Type: Boolean

Return Type

Boolean

None

Determines whether no object exists which meets a specified condition. If no Condition is specified the list checks whether the List is empty. If the list is empty the method will return TRUE.

Syntax

None ( Objects [, ObjectName] [, Condition] )

Parameters

Objects List of objects which will be evaluated. Type: List<Any>

ObjectName (optional) Variable Name to identify the object in the condition. Type: String

Condition (optional) Condition used to evaluate the list. Type: Boolean

Return Type

Boolean

One

Takes a list of Objects as input and determine whether at least one object exists which meets a specified condition. If no objects are provided the function will return FALSE.

Syntax

One ( Objects [, ObjectName] [, Condition] )

Parameters

Objects List of objects which will be evaluated. Type: List<Any>

ObjectName (optional) Variable Name to identify the object in the condition. Type: String

Condition (optional) Condition used to evaluate the list. Type: Boolean

Return Type

Any

OrderAscending

Takes a list of objects and a selection as input and orders the objects according to the selection in ascending fashion.

Syntax

OrderAscending ( Objects [, ObjectName] [, Selection] )

Parameters

Objects List of objects used as basis for the operation. Type: List<Any>

ObjectName (optional) Variable Name to identify the object in the condition. Type: String

Selection (optional) The selection which is used as criteria for the ordering. Type: Any

Return Type

List<Any>

OrderDescending

Takes a list of objects and a selection as input and orders the objects according to the selection in descending fashion.

Syntax

OrderDescending ( Objects [, ObjectName] [, Selection] )

Parameters

Objects List of objects used as basis for the operation. Type: List<Any>

ObjectName (optional) Variable Name to identify the object in the condition. Type: String

Selection (optional) The selection which is used as criteria for the ordering. Type: Any

Return Type

List<Any>

Reverse

Takes a list of Objects and reverses the Order.

Syntax

Reverse ( Objects )

Parameters

Objects The list of Objects to reverses. Type: List<Any>

Return Type

List<Any>

Select

Projects each value of the <see cref="CollectionElement.Objects"/> into a new form.

Syntax

Select ( Objects , ObjectName , Selection )

Parameters

Objects List of Objects which are evaluated. Type: List<Any>

ObjectName Variable Name to identify the object in the condition. Type: String

Selection The selection which is used as criteria for the select. Type: Any

Return Type

List<Any>

Single

Returns the single value (that met a <see cref="Condition"/> if one is provided).

Syntax

Single ( Objects [, ObjectName] [, Condition] )

Parameters

Objects List of Objects which is evaluated. Type: List<Any>

ObjectName (optional) Variable Name to identify the object in the condition. Type: String

Condition (optional) Condition used to evaluate the list. Type: Boolean

Return Type

Any

Skip

Skips a number of Objects and returns the rest.

Syntax

Skip ( Objects , Count )

Parameters

Objects The list of Objects to skip from. Type: List<Any>

Count The amount of Objects to skip. Type: Int

Return Type

List<Any>

Take

Returns a number of Objects and skips the rest.

Syntax

Take ( Objects , Count )

Parameters

Objects The list of Objects to Take from. Type: List<Any>

Count The amount of of Objects to Take. Type: Int

Return Type

List<Any>

Where

Returns a list of Objects which satisfy a specified condition.

Syntax

Where ( Objects , ObjectName , Condition )

Parameters

Objects List of Objects which are evaluated. Type: List<Object>

ObjectName Variable Name to identify the object in the condition. Type: String

Condition Condition used to evaluate the list. Type: Boolean

Return Type

List<Any>

Last updated