Documentation

Class AggregateResult

Represents a result returned by an aggregate function.

Inheritance
System.Object
AggregateResult
Namespace: Telerik.Windows.Data
Assembly: Telerik.Windows.Data.dll

Syntax

public class AggregateResult : Object, INotifyPropertyChanged

Constructors

AggregateResult(Object, Int32, AggregateFunction)

Initializes a new instance of the AggregateResult class.

Declaration
public AggregateResult(object value, int itemCount, AggregateFunction aggregateFunction)
Parameters
System.Object value

The value of the result.
System.Int32 itemCount

The number of arguments used for the calculation of the result.
AggregateFunction aggregateFunction

Function that generated the result.
Exceptions
System.ArgumentNullException

aggregateFunction is null.

AggregateResult(Object, AggregateFunction)

Initializes a new instance of the AggregateResult class.

Declaration
public AggregateResult(object value, AggregateFunction function)
Parameters
System.Object value

The value of the result.
AggregateFunction function

AggregateFunction that generated the result.

AggregateResult(AggregateFunction)

Initializes a new instance of the AggregateResult class.

Declaration
public AggregateResult(AggregateFunction function)
Parameters
AggregateFunction function

AggregateFunction that generated the result.
Exceptions
System.ArgumentNullException

function is null.

Properties

Caption

Gets or sets the text which serves as a caption for the result in a user interface..

Declaration
public string Caption { get; }
Property Value
System.String

The text which serves as a caption for the result in a user interface.

FormattedValue

Gets the formatted value of the result.

Declaration
public object FormattedValue { get; set; }
Property Value
System.Object

The formatted value of the result.

FunctionName

Gets the name of the function.

Declaration
public string FunctionName { get; }
Property Value
System.String

The name of the function.

ItemCount

Gets or sets the number of arguments used for the calculation of the result.

Declaration
public int ItemCount { get; }
Property Value
System.Int32

The number of arguments used for the calculation of the result.

Value

Gets or sets the value of the result.

Declaration
public object Value { get; }
Property Value
System.Object

The value of the result.

Methods

OnPropertyChanged(String)

Called when a property has changed.

Declaration
protected void OnPropertyChanged(string propertyName)
Parameters
System.String propertyName

Name of the property.

ToString()

Returns a System.String that represents the current System.Object.

Declaration
public override string ToString()
Returns
System.String

A System.String that represents the current System.Object.

Events

PropertyChanged

Occurs when a property value changes.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler

Extension Methods