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

AggregateResult

Class

Information for aggregates on the data.

Definition

Assembly:Telerik.DataSource.dll

Syntax:

public class AggregateResult

Inheritance: objectAggregateResult

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 count, AggregateFunction function)

Parameters:valueobject

The value of the result.

countint

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

functionAggregateFunction

Function that generated the result.

Exceptions:

ArgumentNullException

function is null.

Methods

Format(string)

string

Returns a formatted string based on the passed format and the current result value.

public string Format(string format)

Parameters:formatstringReturns:

string

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()

Properties

AggregateMethodName

string

The name of the aggregation method that is used.

public string AggregateMethodName { get; }

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; }

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 calulation of the result.

public int ItemCount { get; set; }

Property Value:

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

Member

string

The name of the field over which aggregation is performed.

public string Member { get; }

Value

object

Gets or sets the value of the result.

public object Value { get; }

Property Value:

The value of the result.