Class
AggregateResult

Information for aggregates on the data.

Definition

Assembly:Telerik.DataSource.dll

Syntax:

cs-api-definition

public class AggregateResult

Inheritance: objectAggregateResult

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

Parameters

value

object

The value of the result.

count

int

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

function

AggregateFunction

Function that generated the result.

Exceptions

ArgumentNullException

function is null.

Properties

AggregateMethodName

The name of the aggregation method that is used.

Declaration

cs-api-definition

public string AggregateMethodName { get; }

Property Value

string

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

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

Declaration

cs-api-definition

public int ItemCount { get; set; }

Property Value

int

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

Member

The name of the field over which aggregation is performed.

Declaration

cs-api-definition

public string Member { get; }

Property Value

string

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

Format(string)

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

Declaration

cs-api-definition

public string Format(string format)

Parameters

format

string

Returns

string

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

ClassAggregateResult

Class
AggregateResult