Class
OlapGroupName

A class that represents an olap group name.

Definition

Namespace:Telerik.Pivot.Core.Olap

Assembly:Telerik.Pivot.Core.dll

Syntax:

cs-api-definition
[DataContract]
[SuppressMessage("Microsoft.Design", "CA1036:OverrideMethodsOnComparableTypes", Justification = "OlapGroupNames are not supposed to participate in comparison operations.")]
public class OlapGroupName : IComparable

Inheritance: objectOlapGroupName

Implements: IComparable

Constructors

OlapGroupName(string)

Initializes a new instance of the OlapGroupName class by provided group name.

Declaration

cs-api-definition
public OlapGroupName(string groupName)

Parameters

groupName

string

The group caption used to display the group in UI and compare the group with other groups. Sets the GroupCaption and GroupKey properties.

OlapGroupName(string, object)

Initializes a new instance of the OlapGroupName class by provided caption and a group key object.

Declaration

cs-api-definition
public OlapGroupName(string groupCaption, object groupKey)

Parameters

groupCaption

string

The group caption used to display the group in UI. Sets the GroupCaption property.

groupKey

object

The group key used to identify and compare the group with other groups. Sets the GroupKey property.

Properties

GroupCaption

Gets or sets the GroupCaption. Use setter only on groups created by you.

Declaration

cs-api-definition
[DataMember]
public string GroupCaption { get; set; }

Property Value

string

GroupKey

Gets or sets the GroupCaption. Use setter only on groups created by you.

Declaration

cs-api-definition
[DataMember]
public object GroupKey { get; set; }

Property Value

object

SortKeys

Gets the keys based on which Sorting is applied.

Declaration

cs-api-definition
[DataMember]
public Collection<string> SortKeys { get; }

Property Value

Collection<string>

Methods

CompareTo(object)

Declaration

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

Parameters

obj

object

Returns

int

Implements IComparable.CompareTo(object)

Equals(object)

Declaration

cs-api-definition
public override bool Equals(object obj)

Parameters

obj

object

Returns

bool

Overrides object.Equals(object)

GetHashCode()

Declaration

cs-api-definition
public override int GetHashCode()

Returns

int

Overrides object.GetHashCode()

ToString()

Declaration

cs-api-definition
public override string ToString()

Returns

string

Overrides object.ToString()