Documentation

Class YearGroup

Used for Name values of IGroups that are grouping by System.DateTime. The YearGroup contains the items with System.DateTime values with the same Year.

Inheritance
System.Object
YearGroup
Namespace: Telerik.Pivot.Core.Groups
Assembly: Telerik.Pivot.Core.dll

Syntax

public sealed class YearGroup : ValueType, IComparable, IComparable<YearGroup>, IEquatable<YearGroup>

Constructors

YearGroup(Int32)

Initializes a new instance of the YearGroup struct.

Declaration
public YearGroup(int year)
Parameters
System.Int32 year

The year which this YearGroup will represents.

YearGroup(Int32, CultureInfo)

Initializes a new instance of the YearGroup struct.

Declaration
public YearGroup(int year, CultureInfo culture)
Parameters
System.Int32 year

The year which this YearGroup will represents.
System.Globalization.CultureInfo culture

The culture.

Properties

Year

Gets the Year this YearGroup represents.

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

Methods

CompareTo(Object)

Declaration
public int CompareTo(object obj)
Parameters
System.Object obj

Returns
System.Int32

CompareTo(YearGroup)

Declaration
public int CompareTo(YearGroup other)
Parameters
YearGroup other

Returns
System.Int32

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Returns
System.Boolean

Equals(YearGroup)

Declaration
public bool Equals(YearGroup other)
Parameters
YearGroup other

Returns
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
System.Int32

ToString()

Declaration
public override string ToString()
Returns
System.String

Operators

Equality(YearGroup, YearGroup)

Determines whether two specified instances of YearGroup are equal.

Declaration
public static bool operator ==(YearGroup left, YearGroup right)
Parameters
YearGroup left

The first object to compare.
YearGroup right

The second object to compare.
Returns
System.Boolean

true if left and right represent the same year group; otherwise, false.

GreaterThan(YearGroup, YearGroup)

Determines whether one specified YearGroup is greater than another specified YearGroup.

Declaration
public static bool operator>(YearGroup left, YearGroup right)
Parameters
YearGroup left

The first object to compare.
YearGroup right

The second object to compare.
Returns
System.Boolean

true if left is greater than right; otherwise, false.

GreaterThanOrEqual(YearGroup, YearGroup)

Determines whether one specified YearGroup is greater than or equal to another specified YearGroup.

Declaration
public static bool operator >=(YearGroup left, YearGroup right)
Parameters
YearGroup left

The first object to compare.
YearGroup right

The second object to compare.
Returns
System.Boolean

true if left is greater than or equal to right; otherwise, false.

Inequality(YearGroup, YearGroup)

Determines whether two specified instances of YearGroup are not equal.

Declaration
public static bool operator !=(YearGroup left, YearGroup right)
Parameters
YearGroup left

The first object to compare.
YearGroup right

The second object to compare.
Returns
System.Boolean

true if left and right do not represent the same year group; otherwise, false.

LessThan(YearGroup, YearGroup)

Determines whether one specified YearGroup is less than another specified YearGroup.

Declaration
public static bool operator <(YearGroup left, YearGroup right)
Parameters
YearGroup left

The first object to compare.
YearGroup right

The second object to compare.
Returns
System.Boolean

true if left is less than right; otherwise, false.

LessThanOrEqual(YearGroup, YearGroup)

Determines whether one specified YearGroup is less than or equal to another specified YearGroup.

Declaration
public static bool operator <=(YearGroup left, YearGroup right)
Parameters
YearGroup left

The first object to compare.
YearGroup right

The second object to compare.
Returns
System.Boolean

true if left is less than or equal to right; otherwise, false.

Extension Methods