Documentation

Class OlapGroupName

A class that represents an olap group name.

Inheritance
System.Object
OlapGroupName
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Pivot.Core.Olap
Assembly: Telerik.WinControls.PivotGrid.dll

Syntax

public class OlapGroupName : IComparable

Constructors

OlapGroupName(String)

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

Declaration
public OlapGroupName(string groupName)
Parameters
System.String groupName

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
public OlapGroupName(string groupCaption, object groupKey)
Parameters
System.String groupCaption

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

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
public string GroupCaption { get; set; }
Property Value
System.String

GroupKey

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

Declaration
public object GroupKey { get; set; }
Property Value
System.Object

SortKeys

Gets the keys based on which Sorting is applied.

Declaration
public Collection<string> SortKeys { get; }
Property Value
System.Collections.ObjectModel.Collection<System.String>

Methods

CompareTo(Object)

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

Returns
System.Int32

Implements
System.IComparable.CompareTo(System.Object)

Equals(Object)

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

Returns
System.Boolean

Overrides
System.Object.Equals(System.Object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
System.Int32

Overrides
System.Object.GetHashCode()

ToString()

Declaration
public override string ToString()
Returns
System.String

Overrides
System.Object.ToString()

Extension Methods