GetGroupByExpression
Provides a String of field names with their sort order separated by comma for this object and any joined objects. The Recursive property on this objects and on the joined objects determine if the joined objects will also try to create sort expressions from their joined objects. This process will follow until the depth reaches maxLevel parameter value.
Parameters:
| Description | |
|---|---|
| recur | Recursion type that will determine what kind of joined objects will be covered. If Recursion is set to RecursionTypes.Parent then only the Join objects with relationship type of Parent will be covered and hence same process for Child relationship. |
| level | Current level in recursion. |
| maxLevels | Maximum levels of business objects to cover during recursion. |
| objectsCovered | A collection that can be used to track what business objects are already covered. |
| groupByFields | A collection that is used to add all the fields that will be used to build the group by expression. |
Returns:
| Type | |
|---|---|
| System.String |
| C# | |
|---|---|
public string GetGroupByExpression( ref RecursionTypes recur, ref int level, ref int maxLevels, ref IBusinessObjectCollection objectsCovered, ref IFieldCollection groupByFields ) | |
Parameters
- recur
- level
- maxLevels
- objectsCovered
- groupByFields
Target Platforms: .NET Framework 1.1 or .NET Framework 2.0