ClassGridGroupByExpression
Expression similar to SQL's "Select Group By" clause that is used by GridTableView to group items . Expressions can be defined by assigning Expression property and/or managing the items in SelectFields or GroupByFields collections.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.GridView.dll
Syntax:
public class GridGroupByExpression : GroupDescriptor, INotifyPropertyChangedInheritance: objectGroupDescriptorGridGroupByExpression
Implements:
Inherited Members
Constructors
GridGroupByExpression()
Initializes a new instance of the GridGroupByExpression class.
Declaration
public GridGroupByExpression()GridGroupByExpression(GridViewDataColumn)
Constructs a new GroupByExpression from a grid GridColumn.
Declaration
public GridGroupByExpression(GridViewDataColumn column)Parameters
column
the column (and its FieldName respectively) that will be used for grouping RadGridView
Remarks
The AllowGroup of the column should be true. The following properties will be copied from the corresponding column's properties:
GridGroupByExpression(string)
Initializes a new instance of the GridGroupByExpression class.
Declaration
public GridGroupByExpression(string expression)Parameters
expression
The expression.
GridGroupByExpression(string, string)
Initializes a new instance of the GridGroupByExpression class.
Fields
Properties
DefaultFormatString
Gets or Sets the format string that is applied to group expressions that have no explicitly specified format string.
Expression
String representation of the GroupBy expression. See Remarks for details.
Declaration
public override string Expression { get; set; }Property Value
Overrides
Remarks
Create group-by expressions, using the following expression syntax:
fieldname[ as alias] [format "..."]|aggregate(fieldname|alias)[as alias][, ...]
Group By fieldname|alias [ASC|DESC]
Where:
fieldname: name of any field from the DataSource
alias: alias string. This cannot contain blanks or other reserved symbols like
',', '.' etc.
aggregate: any of - min, max, sum, count, last, first etc (the same as
in GridAggregateFunction enumeration)
formatstring identical to the one used with string.Format, where the
first argument is the field name or the alias and the second one is the actual
value. The default value is "{0}: {1}"
Example: Country, City, count(Country) Items, ContactName Group By
Country, City desc
Example
Country, City, count(Country) Items, ContactName Group By Country, City descCountry, City, count(Country) Items, ContactName Group By Country, City descGroupByFields
Gets a collection of GridGroupByField objects that form the grouping clause. Standing on the right side of the "Group By" clause
Declaration
[Browsable(false)]
public GridGroupByFieldCollection GroupByFields { get; }Property Value
Index
Gets the index of the expression if added in a GridGroupByExpressionCollection
Declaration
[Browsable(false)]
public int Index { get; }Property Value
integer, representing the index of the collection ni GridGroupByExpressionCollection.
SelectFields
Gets a collection of SelectField objects (field names, aggregates etc.) that form the "Select" clause. Standing on the left side of the "Group By" clause.
Declaration
[Browsable(false)]
public GridGroupByFieldCollection SelectFields { get; }Property Value
Methods
ContainsSameGroupByField(GridGroupByExpression)
Checks if the given expression contains same Group-By field as this one.
Declaration
public bool ContainsSameGroupByField(GridGroupByExpression expression)Parameters
expression
Expression to check
Returns
true if the expression already contains this GroupByField, otherwise false.
Remarks
Use this function to determine if two expressions seem to produce the same set of results
CopyFrom(GridGroupByExpression)
Copies from the passed GridGroupByExpression.
Declaration
public void CopyFrom(GridGroupByExpression expression)Parameters
expression
The expression.
GetHashCode()
Serves as a hash function for a particular type.
IsSame(GridGroupByExpression)
Compares the current expression against the expression set as parameter and check if both expressions contain field with the same name.
Declaration
public bool IsSame(GridGroupByExpression expression)Parameters
expression
expression to check against this expression
Returns
<strong>true</strong> if both expressions contain field with the same name,otherwise false.
Parse(string)
Calls GridGroupByExpression(expression)
Declaration
public static GridGroupByExpression Parse(string expression)Parameters
expression
Returns
ToString()
The same as the Expression property
Declaration
public override string ToString()Returns
the string representation of the expression.
Overrides