AggregateOperand Members

An aggregate operator which calculates aggregate expressions (MIN, MAX, SUM, etc.)

Constructors

Name Description
AggregateOperand() Initializes a new instance of the AggregateOperand class with default settings.
AggregateOperand(OperandProperty, CriteriaOperator, Aggregate, CriteriaOperator) Initializes a new instance of the AggregateOperand class with the specified settings.
AggregateOperand(OperandProperty, IEnumerable<CriteriaOperator>, String, CriteriaOperator) Initializes a new instance of the AggregateOperand class with specified settings.
AggregateOperand(String, Aggregate) Initializes a new instance of the AggregateOperand class with the specified collection property and operator type.
AggregateOperand(String, Aggregate, CriteriaOperator) Initializes a new instance of the AggregateOperand class.
AggregateOperand(String, String) Initializes a new instance of the AggregateOperand class with specified settings.
AggregateOperand(String, String, Aggregate) Initializes a new instance of the AggregateOperand class with the specified settings.
AggregateOperand(String, String, Aggregate, CriteriaOperator) Initializes a new instance of the AggregateOperand class with the specified settings.
AggregateOperand(String, String, CriteriaOperator) Initializes a new instance of the AggregateOperand class with specified settings.

Properties

Name Description
AggregatedExpression Gets or sets the aggregated expression.
AggregateType Gets or sets the type of the aggregate operator.
CollectionProperty Gets or sets a collection property whose elements are used to calculate an aggregate expression.
Condition Gets or sets the filter criteria which is applied to AggregateOperand values.
CustomAggregateCount static Inherited from CriteriaOperator.
CustomAggregateName Gets or sets a custom aggregate function's name. The property value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single.
CustomAggregateOperands Gets an operand collection passed to a custom aggregate function.
CustomFunctionCount static Returns the number of custom functions registered in an application via the CriteriaOperator.RegisterCustomFunction and CriteriaOperator.RegisterCustomFunctions method calls. Inherited from CriteriaOperator.
IsTopLevel This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Methods

Name Description
Accept(ICriteriaVisitor) For internal use.
Accept<T>(ICriteriaVisitor<T>) For internal use.
And(CriteriaOperator, CriteriaOperator) static Returns the expression which groups two operands with logical AND. Inherited from CriteriaOperator.
And(CriteriaOperator[]) static Returns the expression which groups the specified operands with logical AND. Inherited from CriteriaOperator.
And(IEnumerable<CriteriaOperator>) static Returns the expression which groups the specified operands with logical AND. Inherited from CriteriaOperator.
Avg(CriteriaOperator) Creates a new AggregateOperand which returns the average of values calculated by the given aggregate expression. This expression is evaluated against elements of the AggregateOperand.CollectionProperty that match the specified AggregateOperand.Condition.
Clone() Creates a copy of the current AggregateOperand instance.
Clone(CriteriaOperator) static Creates a copy of the specified CriteriaOperator object. Inherited from CriteriaOperator.
Clone(OperandProperty) static Creates a copy of the specified OperandProperty object. Inherited from CriteriaOperator.
Count() Creates a new AggregateOperand which returns the count of AggregateOperand.CollectionProperty elements that match the AggregateOperand.Condition.
Count(CriteriaOperator) Creates a new AggregateOperand which returns the count of AggregateOperand.CollectionProperty elements that match the AggregateOperand.Condition.
CriterionEquals(CriteriaOperator, CriteriaOperator) static This method is intended for internal use. Inherited from CriteriaOperator.
Custom(String, IEnumerable<CriteriaOperator>) Creates a new custom AggregateOperand that returns values calculated by the given aggregate expression. This expression is evaluated against elements of the AggregateOperand.CollectionProperty that match the specified AggregateOperand.Condition.
Equals(Object) Determines whether the current object has the same settings as the specified object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Exists() Creates a new AggregateOperand which determines whether or not the count of AggregateOperand.CollectionProperty elements that match the AggregateOperand.Condition is greater than zero.
Exists(CriteriaOperator) Creates a new AggregateOperand which determines whether or not the count of AggregateOperand.CollectionProperty elements that match the AggregateOperand.Condition is greater than zero.
GetCustomAggregate(String) static Searches custom aggregate functions registered in an application via the RegisterCustomAggregate(ICustomAggregate) and RegisterCustomAggregates(IEnumerable<ICustomAggregate>) method calls for a function with a specified name. Inherited from CriteriaOperator.
GetCustomAggregates() static Searches custom aggregate functions registered in an application via the RegisterCustomAggregate(ICustomAggregate) and RegisterCustomAggregates(IEnumerable<ICustomAggregate>) method calls. Inherited from CriteriaOperator.
GetCustomFunction(String) static Searches custom functions registered in an application via the CriteriaOperator.RegisterCustomFunction and CriteriaOperator.RegisterCustomFunctions method calls for a function with a specified name. Inherited from CriteriaOperator.
GetCustomFunctions() static Returns custom functions registered in an application via the CriteriaOperator.RegisterCustomFunction and CriteriaOperator.RegisterCustomFunctions method calls. Inherited from CriteriaOperator.
GetHashCode() Gets the hash code (a number) that corresponds to the value of the current AggregateOperand object.
GetType() Gets the Type of the current instance. Inherited from Object.
IsNotNull() For internal use only. Inherited from CriteriaOperator.
IsNull() For internal use only. Inherited from CriteriaOperator.
LegacyToString() Returns the string representation of the criteria specified by the current CriteriaOperator instance. Inherited from CriteriaOperator.
LegacyToString(CriteriaOperator) static Returns the string representation of a specified criteria. Inherited from CriteriaOperator.
Max(CriteriaOperator) Creates a new AggregateOperand which returns the maximum of the values calculated by the given aggregate expression. This expression is evaluated against elements of the AggregateOperand.CollectionProperty that match the specified AggregateOperand.Condition.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
Min(CriteriaOperator) Creates a new AggregateOperand which returns the minimum of the values calculated by the given aggregate expression. This expression is evaluated against elements of the AggregateOperand.CollectionProperty that match the specified AggregateOperand.Condition.
Not() Returns an instance of the UnaryOperator that represents the criterion resulting from the logical inversion of the criterion the current CriteriaOperator represents. Inherited from CriteriaOperator.
Or(CriteriaOperator, CriteriaOperator) static Returns the expression which groups two operands with logical OR. Inherited from CriteriaOperator.
Or(CriteriaOperator[]) static Returns the expression which groups the specified operands with logical OR. Inherited from CriteriaOperator.
Or(IEnumerable<CriteriaOperator>) static Returns the expression which groups the specified operands with logical OR. Inherited from CriteriaOperator.
Parse(String, out OperandValue[]) static Converts the specified string, specifying an expression, to its CriteriaOperator equivalent. Inherited from CriteriaOperator.
Parse(String, Object[]) static Converts the specified string, specifying an expression, to its CriteriaOperator equivalent. Inherited from CriteriaOperator.
ParseList(String, out OperandValue[]) static Converts the specified string representation of expressions that are divided by a semicolon into their CriteriaOperator equivalents. Inherited from CriteriaOperator.
ParseList(String, Object[]) static Converts the specified string representation of expressions that are divided by a semicolon into their CriteriaOperator equivalents. Inherited from CriteriaOperator.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RegisterCustomAggregate(ICustomAggregate) static Registers a custom aggregate function to use in any CriteriaOperator-based criteria in your application. Inherited from CriteriaOperator.
RegisterCustomAggregates(IEnumerable<ICustomAggregate>) static Registers custom aggregate functions to use in any CriteriaOperator-based criteria in your application. Inherited from CriteriaOperator.
RegisterCustomFunction(ICustomFunctionOperator) static Registers a specified custom function to use in any CriteriaOperator-based criteria in your application. Inherited from CriteriaOperator.
RegisterCustomFunctions(IEnumerable<ICustomFunctionOperator>) static Registers specified custom functions to use in any CriteriaOperator-based criteria in your application. Inherited from CriteriaOperator.
Single(CriteriaOperator) Creates a new AggregateOperand which returns the single object from the AggregateOperand.CollectionProperty that matches the specified AggregateOperand.Condition. The collection must be empty or contain exactly one object.
Sum(CriteriaOperator) Creates a new AggregateOperand which returns the sum of values calculated by the given aggregate expression. This expression is evaluated against elements of the AggregateOperand.CollectionProperty that match the specified AggregateOperand.Condition.
ToBasicStyleString(CriteriaOperator) static Converts the specified expression into its equivalent string in VB style. Inherited from CriteriaOperator.
ToBasicStyleString(CriteriaOperator, out OperandValue[]) static Converts the specified expression into its equivalent string in VB style. Inherited from CriteriaOperator.
ToCStyleString(CriteriaOperator) static Converts the specified expression into its equivalent string in C# style. Inherited from CriteriaOperator.
ToCStyleString(CriteriaOperator, out OperandValue[]) static Converts the specified expression into its equivalent string in C# style. Inherited from CriteriaOperator.
TopLevel(Aggregate, CriteriaOperator) static Creates a new top-level AggregateOperand that returns values calculated by the given custom aggregate expression.
TopLevel(String, IEnumerable<CriteriaOperator>) static Creates a new top-level AggregateOperand that returns values calculated by the given custom aggregate expression.
ToString() Converts the current expression into its VB equivalent string. Inherited from CriteriaOperator.
ToString(CriteriaOperator) static Converts the specified expression into its equivalent string in VB style. Inherited from CriteriaOperator.
ToString(CriteriaOperator, out OperandValue[]) static Converts the specified expression into its equivalent string in VB style. Inherited from CriteriaOperator.
TryParse(String, Object[]) static Tries to convert the specified string representation of an expression to its CriteriaOperator equivalent. Inherited from CriteriaOperator.
UnregisterCustomAggregate(ICustomAggregate) static Unregisters a specified custom aggregate function from use in any CriteriaOperator-based criteria in your application. Inherited from CriteriaOperator.
UnregisterCustomAggregate(String) static Unregisters a custom aggregate function with a specified name from use in any CriteriaOperator-based criteria in your application. Inherited from CriteriaOperator.
UnregisterCustomFunction(ICustomFunctionOperator) static Unregisters a specified custom function from use in any CriteriaOperator-based criteria in your application. Inherited from CriteriaOperator.
UnregisterCustomFunction(String) static Unregisters a custom function with a specified name from use in any CriteriaOperator-based criteria in your application. Inherited from CriteriaOperator.

Events

Name Description
QueryCustomFunctions static Inherited from CriteriaOperator.
UserValueParse static Occurs when restoring a serialized criteria operator that references a user object. Inherited from CriteriaOperator.
UserValueToString static Occurs when serializing a criteria operator that references a user object. Inherited from CriteriaOperator.
See Also