Struct
YearGroup

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

Definition

Namespace:Telerik.Pivot.Core.Groups

Assembly:Telerik.Pivot.Core.dll

Syntax:

cs-api-definition
public struct YearGroup : IComparable, IComparable<YearGroup>, IEquatable<YearGroup>

Implements: IComparableIComparable<YearGroup>IEquatable<YearGroup>

Constructors

YearGroup(int)

Initializes a new instance of the YearGroup struct.

Declaration

cs-api-definition
public YearGroup(int year)

Parameters

year

int

The year which this YearGroup will represents.

YearGroup(int, CultureInfo)

Initializes a new instance of the YearGroup struct.

Declaration

cs-api-definition
public YearGroup(int year, CultureInfo culture)

Parameters

year

int

The year which this YearGroup will represents.

culture

CultureInfo

The culture.

Properties

Year

Gets the Year this YearGroup represents.

Declaration

cs-api-definition
public int Year { readonly get; set; }

Property Value

int

Methods

CompareTo(YearGroup)

Declaration

cs-api-definition
public int CompareTo(YearGroup other)

Parameters

other

YearGroup

Returns

int

Implements IComparable<YearGroup>.CompareTo(YearGroup)

CompareTo(object)

Declaration

cs-api-definition
public int CompareTo(object obj)

Parameters

obj

object

Returns

int

Implements IComparable.CompareTo(object)

Equals(YearGroup)

Declaration

cs-api-definition
public bool Equals(YearGroup other)

Parameters

other

YearGroup

Returns

bool

Implements IEquatable<YearGroup>.Equals(YearGroup)

Equals(object)

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Usage", "CA2231:OverloadOperatorEqualsOnOverridingValueTypeEquals", Justification = "Design choice.")]
public override bool Equals(object obj)

Parameters

obj

object

Returns

bool

Overrides ValueType.Equals(object)

GetHashCode()

Declaration

cs-api-definition
public override int GetHashCode()

Returns

int

Overrides ValueType.GetHashCode()

ToString()

Declaration

cs-api-definition
public override string ToString()

Returns

string

Overrides ValueType.ToString()

Operators

operator !=(YearGroup, YearGroup)

Determines whether two specified instances of YearGroup are not equal.

Declaration

cs-api-definition
public static bool operator !=(YearGroup left, YearGroup right)

Parameters

left

YearGroup

The first object to compare.

right

YearGroup

The second object to compare.

Returns

bool

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

operator <(YearGroup, YearGroup)

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

Declaration

cs-api-definition
public static bool operator <(YearGroup left, YearGroup right)

Parameters

left

YearGroup

The first object to compare.

right

YearGroup

The second object to compare.

Returns

bool

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

operator <=(YearGroup, YearGroup)

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

Declaration

cs-api-definition
public static bool operator <=(YearGroup left, YearGroup right)

Parameters

left

YearGroup

The first object to compare.

right

YearGroup

The second object to compare.

Returns

bool

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

operator ==(YearGroup, YearGroup)

Determines whether two specified instances of YearGroup are equal.

Declaration

cs-api-definition
public static bool operator ==(YearGroup left, YearGroup right)

Parameters

left

YearGroup

The first object to compare.

right

YearGroup

The second object to compare.

Returns

bool

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

operator >(YearGroup, YearGroup)

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

Declaration

cs-api-definition
public static bool operator >(YearGroup left, YearGroup right)

Parameters

left

YearGroup

The first object to compare.

right

YearGroup

The second object to compare.

Returns

bool

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

operator >=(YearGroup, YearGroup)

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

Declaration

cs-api-definition
public static bool operator >=(YearGroup left, YearGroup right)

Parameters

left

YearGroup

The first object to compare.

right

YearGroup

The second object to compare.

Returns

bool

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