Skip to main content

AggregateOperand Members

The operator that calculates an aggregate expression (MIN, MAX, SUM, etc.).

Constructors

Name Description
AggregateOperand() Initializes an AggregateOperand instance with the default settings.
AggregateOperand(OperandProperty, CriteriaOperator, Aggregate, CriteriaOperator) Initializes an AggregateOperand instance with the specified criterion determining the collection property, criterion defining the property to aggregate, operator type, and filter criterion.
AggregateOperand(String, Aggregate, CriteriaOperator) Initializes an AggregateOperand instance with the specified collection property name, operator type, and filter criterion.
AggregateOperand(String, Aggregate) Initializes an AggregateOperand instance with the specified collection property name and operator type.
AggregateOperand(String, String, Aggregate, CriteriaOperator) Initializes an AggregateOperand instance with the specified collection property name, name of a property to aggregate, operator type, and filter criterion.
AggregateOperand(String, String, Aggregate) Initializes an AggregateOperand instance with the specified collection property name, name of a property to aggregate, and operator type.

Properties

Name Description
AggregatedExpression Gets or sets the operator that defines how to process objects from a collection that CollectionProperty specifies.
AggregateType Gets or sets the type of the aggregate operator.
CollectionProperty Gets or sets an operand that specifies the collection property by which the aggregate operand evaluates the average value.
Condition Gets or sets the filter criterion the aggregate operand uses to filter values to aggregate from the collection property that the CollectionProperty specifies.
CustomFunctionCount static Returns the number of registered custom functions. 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 only. Accepts the specified visitor.
Accept<T>(ICriteriaVisitor<T>) For internal use only. Accepts the specified visitor.
And(CriteriaOperator, CriteriaOperator) static Initializes a new CriteriaOperator that groups specified criteria via the logical AND operator. Inherited from CriteriaOperator.
And(CriteriaOperator[]) static Initializes a new CriteriaOperator that groups specified criteria via the logical AND operator. Inherited from CriteriaOperator.
And(IEnumerable<CriteriaOperator>) static Initializes a new CriteriaOperator that groups specified criteria via the logical AND operator. Inherited from CriteriaOperator.
Avg(CriteriaOperator) Initializes a new AggregateOperand instance that evaluates the average value of a property the aggregateExpression argument specifies. The new operand computes the aggregate value against elements of the current operand’s CollectionProperty that match the current operand’s Condition.
Clone() Initializes a new AggregateOperand instance that is a copy of the current instance.
Clone(CriteriaOperator) static Initializes a new CriteriaOperator instance that is a copy of the specified instance instance. Inherited from CriteriaOperator.
Clone(OperandProperty) static Initializes a new OperandProperty instance that is a copy of the specified instance instance. Inherited from CriteriaOperator.
Clone(ICollection) protected static Inherited from CriteriaOperator.
CloneCommon() protected
Count() Initializes a new AggregateOperand instance that evaluates the count of objects in the collection. The new operand computes the aggregate value against elements of the current operand’s CollectionProperty that match the current operand’s Condition.
Count(CriteriaOperator) Initializes a new AggregateOperand instance that evaluates the count of objects in the collection. The new operand computes the aggregate value against elements of the current operand’s CollectionProperty that match the current operand’s Condition.
CriterionEquals(CriteriaOperator, CriteriaOperator) static Determines whether the specified CriteriaOperators are equal. Inherited from CriteriaOperator.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current AggregateOperand instance.
Exists() Initializes a new AggregateOperand instance that evaluates whether an object exists in the collection. The new operand computes the aggregate value against elements of the current operand’s CollectionProperty that match the current operand’s Condition.
Exists(CriteriaOperator) Initializes a new AggregateOperand instance that evaluates whether the object that corresponds to the specified aggregatedExpression exists. The new operand computes the aggregate value against elements of the current operand’s CollectionProperty that match the current operand’s Condition.
GetCustomFunction(String) static Returns a registered custom function with the specified name. Inherited from CriteriaOperator.
GetCustomFunctions() static Returns all registered custom functions. Inherited from CriteriaOperator.
GetHashCode() Serves as the default hash function.
GetType() Gets the Type of the current instance. Inherited from Object.
IsNotNull() Initializes a new UnaryOperator instance that checks whether the current criterion is not null. Inherited from CriteriaOperator.
IsNull() Initializes a new UnaryOperator instance that checks whether the current criterion is null. Inherited from CriteriaOperator.
LegacyToString() Converts the current expression into its string equivalent and removes value suffixes (like 'm', 'M', 'l', 'L', etc.) Inherited from CriteriaOperator.
LegacyToString(CriteriaOperator) static Converts the specified expression into its string equivalent and removes value suffixes (like 'm', 'M', 'l', 'L', etc.) Inherited from CriteriaOperator.
Max(CriteriaOperator) Initializes a new AggregateOperand instance that evaluates the maximum value in the collection. The new operand computes the aggregate value against elements of the current operand’s CollectionProperty that match the current operand’s Condition.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
Min(CriteriaOperator) Initializes a new AggregateOperand instance that evaluates the minimum value in the collection. The new operand computes the aggregate value against elements of the current operand’s CollectionProperty that match the current operand’s Condition.
Not() Initializes a new UnaryOperator instance that applies the logical NOT operator to the current criterion. Inherited from CriteriaOperator.
ObjectToCriteriaSafe(Object) protected static Inherited from CriteriaOperator.
Or(CriteriaOperator, CriteriaOperator) static Initializes a new CriteriaOperator that groups specified criteria via the logical OR operator. Inherited from CriteriaOperator.
Or(CriteriaOperator[]) static Initializes a new CriteriaOperator that groups specified criteria via the logical OR operator. Inherited from CriteriaOperator.
Or(IEnumerable<CriteriaOperator>) static Initializes a new CriteriaOperator that groups specified criteria via the logical OR operator. Inherited from CriteriaOperator.
Parse(String, out OperandValue[]) static Converts the specified string into its CriteriaOperator equivalent. Throws an exception if it cannot convert the string to a criterion. Inherited from CriteriaOperator.
Parse(String, Object[]) static Converts the specified string into its CriteriaOperator equivalent. Throws an exception if it cannot convert the string to a criterion. Inherited from CriteriaOperator.
ParseList(String, out OperandValue[]) static Converts the specified string into its CriteriaOperators equivalent. Expressions should be divided by a semicolon (';'). Throws an exception if it cannot convert the string to criteria. Inherited from CriteriaOperator.
ParseList(String, Object[]) static Converts the specified string into its CriteriaOperators equivalent. Expressions should be divided by a semicolon (';'). Throws an exception if it cannot convert the string to criteria. Inherited from CriteriaOperator.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RegisterCustomFunction(ICustomFunctionOperator) static Registers the specified custom function. Inherited from CriteriaOperator.
RegisterCustomFunctions(IEnumerable<ICustomFunctionOperator>) static Registers the specified custom functions. Inherited from CriteriaOperator.
Single(CriteriaOperator) Creates a new AggregateOperand which returns the single object from the current operand’s CollectionProperty that matches the current operand’s <AggregateOperand.Condition. The collection must be empty or contain one object.
Sum(CriteriaOperator) Creates a new AggregateOperand instance that evaluates the summary value of a property the aggregateExpression argument specifies. The new operand computes the aggregate value against elements of the current operand’s CollectionProperty that match the current operand’s Condition.
ToBasicStyleString(CriteriaOperator, out OperandValue[]) static Converts the specified expression into its VB-style string equivalent. Inherited from CriteriaOperator.
ToBasicStyleString(CriteriaOperator) static Converts the specified expression into its VB-style string equivalent. Inherited from CriteriaOperator.
ToCStyleString(CriteriaOperator, out OperandValue[]) static Converts the specified expression into its C#-style string equivalent. Inherited from CriteriaOperator.
ToCStyleString(CriteriaOperator) static Converts the specified expression into its C#-style string equivalent. Inherited from CriteriaOperator.
ToString() Converts the current expression into its VB-style string equivalent. Inherited from CriteriaOperator.
ToString(CriteriaOperator, out OperandValue[]) static Converts the specified expression into its VB-style string equivalent. Inherited from CriteriaOperator.
ToString(CriteriaOperator) static Converts the specified expression into its VB-style string equivalent. Inherited from CriteriaOperator.
TryParse(String, Object[]) static Converts the specified string into its CriteriaOperator equivalent. Returns null if cannot convert the string to a criterion. Inherited from CriteriaOperator.
UnregisterCustomFunction(ICustomFunctionOperator) static Cancels registration of the specified custom function. Inherited from CriteriaOperator.
UnregisterCustomFunction(String) static Cancels registration of a custom function with the specified name. Inherited from CriteriaOperator.

Events

Name Description
UserValueParse static Occurs when a criteria operator parses a serialized user object. Inherited from CriteriaOperator.
UserValueToString static Occurs when a criteria operator serializes a user object. Inherited from CriteriaOperator.
See Also