Struct
WeekGroup

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

Definition

Namespace:Telerik.Pivot.Core.Groups

Assembly:Telerik.Pivot.Core.dll

Syntax:

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

Implements: IComparableIComparable<WeekGroup>IEquatable<WeekGroup>

Constructors

WeekGroup(int)

Initializes a new instance of the WeekGroup struct.

Declaration

cs-api-definition
public WeekGroup(int week)

Parameters

week

int

The week which this WeekGroup will represents.

WeekGroup(int, CultureInfo)

Initializes a new instance of the WeekGroup struct.

Declaration

cs-api-definition
public WeekGroup(int week, CultureInfo culture)

Parameters

week

int

The week which this WeekGroup will represents.

culture

CultureInfo

The culture.

Properties

Week

Gets the Week this WeekGroup represents.

Declaration

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

Property Value

int

Methods

CompareTo(WeekGroup)

Declaration

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

Parameters

other

WeekGroup

Returns

int

Implements IComparable<WeekGroup>.CompareTo(WeekGroup)

CompareTo(object)

Declaration

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

Parameters

obj

object

Returns

int

Implements IComparable.CompareTo(object)

Equals(WeekGroup)

Declaration

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

Parameters

other

WeekGroup

Returns

bool

Implements IEquatable<WeekGroup>.Equals(WeekGroup)

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 !=(WeekGroup, WeekGroup)

Determines whether two specified instances of WeekGroup are not equal.

Declaration

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

Parameters

left

WeekGroup

The first object to compare.

right

WeekGroup

The second object to compare.

Returns

bool

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

operator <(WeekGroup, WeekGroup)

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

Declaration

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

Parameters

left

WeekGroup

The first object to compare.

right

WeekGroup

The second object to compare.

Returns

bool

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

operator <=(WeekGroup, WeekGroup)

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

Declaration

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

Parameters

left

WeekGroup

The first object to compare.

right

WeekGroup

The second object to compare.

Returns

bool

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

operator ==(WeekGroup, WeekGroup)

Determines whether two specified instances of WeekGroup are equal.

Declaration

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

Parameters

left

WeekGroup

The first object to compare.

right

WeekGroup

The second object to compare.

Returns

bool

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

operator >(WeekGroup, WeekGroup)

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

Declaration

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

Parameters

left

WeekGroup

The first object to compare.

right

WeekGroup

The second object to compare.

Returns

bool

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

operator >=(WeekGroup, WeekGroup)

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

Declaration

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

Parameters

left

WeekGroup

The first object to compare.

right

WeekGroup

The second object to compare.

Returns

bool

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