Class
AggregateResult

Represents a result returned by an aggregate function.

Definition

Namespace:Telerik.Windows.Data

Assembly:Telerik.Windows.Data.dll

Syntax:

cs-api-definition

public class AggregateResult : INotifyPropertyChanged

Inheritance: objectAggregateResult

Implements: INotifyPropertyChanged

Constructors

AggregateResult(AggregateFunction)

Initializes a new instance of the AggregateResult class.

Declaration

cs-api-definition

public AggregateResult(AggregateFunction function)

Parameters

function

AggregateFunction

AggregateFunction that generated the result.

Exceptions

ArgumentNullException

function is null.

AggregateResult(object, AggregateFunction)

Initializes a new instance of the AggregateResult class.

Declaration

cs-api-definition

public AggregateResult(object value, AggregateFunction function)

Parameters

value

object

The value of the result.

function

AggregateFunction

AggregateFunction that generated the result.

AggregateResult(object, int, AggregateFunction)

Initializes a new instance of the AggregateResult class.

Declaration

cs-api-definition

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

Parameters

value

object

The value of the result.

itemCount

int

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

aggregateFunction

AggregateFunction

Function that generated the result.

Exceptions

ArgumentNullException

aggregateFunction is null.

Properties

Caption

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

Declaration

cs-api-definition

public string Caption { get; }

Property Value

string

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

FormattedValue

Gets the formatted value of the result.

Declaration

cs-api-definition

public object FormattedValue { get; set; }

Property Value

object

The formatted value of the result.

FunctionName

Gets the name of the function.

Declaration

cs-api-definition

public string FunctionName { get; }

Property Value

string

The name of the function.

ItemCount

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

Declaration

cs-api-definition

public int ItemCount { get; }

Property Value

int

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

Value

Gets or sets the value of the result.

Declaration

cs-api-definition

public object Value { get; }

Property Value

object

The value of the result.

Methods

OnPropertyChanged(string)

Called when a property has changed.

Declaration

cs-api-definition

protected void OnPropertyChanged(string propertyName)

Parameters

propertyName

string

Name of the property.

ToString()

Returns a string that represents the current object.

Declaration

cs-api-definition

public override string ToString()

Returns

string

A string that represents the current object.

Overrides object.ToString()

Events

PropertyChanged

Occurs when a property value changes.

Declaration

cs-api-definition

public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged

ClassAggregateResult

Class
AggregateResult