New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

PivotGridField

Class

A PivotGridField is the main logic unit that relates the content of the pivot grid to fields in the DataSource.

The PivotGridField defines the properties and methods that are common to all field types in RadPivotGrid.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

public abstract class PivotGridField : StateManager, IMarkableStateManager, IStateManager, IComparable, IDisposable, INamingContainer

Inheritance: objectStateManagerPivotGridField

Derived Classes: PivotGridAggregateFieldPivotGridGroupFieldPivotGridReportFilterField

Implements: IComparableIDisposableIMarkableStateManagerINamingContainerIStateManager

Inherited Members StateManager.IsTrackingViewStateStateManager.ViewStateobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

PivotGridField()

protected PivotGridField()

Properties

Caption

string

Gets or sets the field's display caption.

public string Caption { get; set; }

CellStyle

Style

Style of the cells in the the grid, corresponding to the field.

[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual Style CellStyle { get; }

DataField

string

Gets or sets the field name from the specified data source to bind to the PivotGridField.

public string DataField { get; set; }

Property Value:

A string, specifying the data field from the data source, from which to bind the PivotGridField.

DataFormatString

string

Gets or sets the string that specifies the display format for all cells which belongs to this field.

public virtual string DataFormatString { get; set; }

Property Value:

A string that specifies the display format all cells which belongs to this field.

FieldType

string

[Browsable(false)]
public string FieldType { get; }

IsHidden

bool

Gets or sets if the field will be hidden which exlude it from the pivot table calculations.

public bool IsHidden { get; set; }

Property Value:

Determines if the field will be hidden which exlude it from the pivot table calculations.

Owner

RadPivotGrid

[Browsable(false)]
public RadPivotGrid Owner { get; }

RenderingControl

PivotGridFieldRenderingControl

Gets or sets a referance of the PivotGridFieldRenderingControl that allow you to control how the field is rendered.

[Browsable(false)]
public PivotGridFieldRenderingControl RenderingControl { get; set; }

SortOrder

PivotGridSortOrder

Gets or sets a referance instance of the PivotGridSortOrder enum.

public PivotGridSortOrder SortOrder { get; set; }

TotalFormatString

string

Gets or sets the string that specifies the display format for all total cells which belongs to this field.

public virtual string TotalFormatString { get; set; }

Property Value:

A string that specifies the display format all cells which belongs to this field.

Each column in Telerik RadPivotGrid has an UniqueName property (string). This property is assigned automatically by the designer (or the first time you want to access the columns if they are built dynamically).

[Browsable(true)]
public virtual string UniqueName { get; set; }

ZoneIndex

int

Gets or sets the order indexes for fields displayed within the same zone.

public virtual int ZoneIndex { get; set; }

ZoneType

PivotGridFieldZoneType

Gets the zone type of the field which determines in which zone the field is positioned.

[Browsable(false)]
public PivotGridFieldZoneType ZoneType { get; }

Property Value:

The zone type of the field which determines in which zone the field is positioned.

Methods

ClearRenderControl()

public void ClearRenderControl()

CompareTo(object)

public int CompareTo(object obj)

Parameters:objobjectReturns:

int

Implements: IComparable.CompareTo(object)

Dispose()

public void Dispose()

Implements: IDisposable.Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters:disposingbool

GenerateUniqueName()

protected virtual string GenerateUniqueName()

Returns:

string

GenerateUniqueNameBase(string)

protected string GenerateUniqueNameBase(string Base)

Parameters:BasestringReturns:

string

GetLevel()

public int GetLevel()

Returns:

int

IsUniqueName(string)

protected bool IsUniqueName(string testName)

Parameters:testNamestringReturns:

bool

LoadViewState(object)

protected override void LoadViewState(object state)

Parameters:stateobject

Overrides: StateManager.LoadViewState(object)

OnDescriptionInfoChanged()

protected abstract void OnDescriptionInfoChanged()

SaveViewState()

protected override object SaveViewState()

Returns:

object

Overrides: StateManager.SaveViewState()

SetDescriptionInfo()

public void SetDescriptionInfo()

Show()

Sets the IsHidden property to false and sets the ZoneIndex so the field will be placed as last in the zone

public void Show()

TrackViewState()

protected override void TrackViewState()

Overrides: StateManager.TrackViewState()