New to Telerik UI for WPF? Start a free 30-day trial

AggregateResult

Class

Represents a result returned by an aggregate function.

Definition

Namespace:Telerik.Windows.Data

Assembly:Telerik.Windows.Data.dll

Syntax:

public class AggregateResult : INotifyPropertyChanged

Inheritance: objectAggregateResult

Implements: INotifyPropertyChanged

Constructors

AggregateResult(AggregateFunction)

Initializes a new instance of the AggregateResult class.

public AggregateResult(AggregateFunction function)

Parameters:functionAggregateFunction

AggregateFunction that generated the result.

Exceptions:

ArgumentNullException

function is null.

AggregateResult(object, AggregateFunction)

Initializes a new instance of the AggregateResult class.

public AggregateResult(object value, AggregateFunction function)

Parameters:valueobject

The value of the result.

functionAggregateFunction

AggregateFunction that generated the result.

AggregateResult(object, int, AggregateFunction)

Initializes a new instance of the AggregateResult class.

public AggregateResult(object value, int itemCount, AggregateFunction aggregateFunction)

Parameters:valueobject

The value of the result.

itemCountint

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

aggregateFunctionAggregateFunction

Function that generated the result.

Exceptions:

ArgumentNullException

aggregateFunction is null.

Properties

Caption

string

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

public string Caption { get; }

Property Value:

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

FormattedValue

object

Gets the formatted value of the result.

public object FormattedValue { get; set; }

Property Value:

The formatted value of the result.

FunctionName

string

Gets the name of the function.

public string FunctionName { get; }

Property Value:

The name of the function.

ItemCount

int

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

public int ItemCount { get; }

Property Value:

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

Value

object

Gets or sets the value of the result.

public object Value { get; }

Property Value:

The value of the result.

Methods

OnPropertyChanged(string)

Called when a property has changed.

protected void OnPropertyChanged(string propertyName)

Parameters:propertyNamestring

Name of the property.

ToString()

string

Returns a string that represents the current object.

public override string ToString()

Returns:

string

A string that represents the current object.

Overrides: object.ToString()

Events

PropertyChanged

PropertyChangedEventHandler

Occurs when a property value changes.

public event PropertyChangedEventHandler PropertyChanged

Implements: INotifyPropertyChanged.PropertyChanged