Class

RadPivotFieldList

Initializes a new instance of the RadPivotFieldList class.

Declaration

public RadPivotFieldList()

Gets or sets the RadPivotGrid control that this field list is associated with. Setting this property automatically associates the field list with the pivot grid's element, enabling bidirectional field configuration.

Declaration

[Browsable(true)]
public RadPivotGrid AssociatedPivotGrid { get; set; }

Property Value

Gets or sets the RadPivotGridElement that this field list is associated with. When set, the field list will reflect and control the field configuration of the associated pivot grid element.

Declaration

[Browsable(false)]
public RadPivotGridElement AssociatedPivotGridElement { get; set; }

Property Value

Gets the RadListControl that displays and manages the column labels area of the pivot field list. Fields dropped into this area will become column headers in the pivot grid.

Declaration

[Browsable(false)]
public RadListControl ColumnLabelsControl { get; }

Property Value

Gets the data provider that supplies data to the associated pivot grid. This property returns the data provider from the associated RadPivotGridElement, or null if no pivot grid is associated.

Declaration

[Browsable(false)]
public IDataProvider DataProvider { get; }

Property Value

Gets or sets a value indicating whether pivot grid updates should be deferred until explicitly executed. When true, field changes will not immediately update the pivot grid; instead, updates must be triggered manually.

Declaration

[Browsable(true)]
public bool DeferUpdates { get; set; }

Property Value

Gets or sets the factory that creates dialogs for the pivot field list. This factory is responsible for creating various dialogs used in pivot grid operations.

Declaration

[Browsable(false)]
public PivotGridDialogsFactory DialogsFactory { get; set; }

Property Value

Gets or sets the drag and drop service that handles field dragging operations within the pivot field list. This service manages the drag and drop behavior for moving fields between different areas.

Declaration

[Browsable(false)]
public PivotFieldListDragDropService DragDropService { get; set; }

Property Value

Gets the RadTreeView control that displays the available fields that can be dragged to different areas of the pivot field list. This tree view shows the hierarchical structure of fields from the data source.

Declaration

[Browsable(false)]
public RadTreeView FieldsControl { get; }

Property Value

Gets the RadListControl that displays and manages the report filters area of the pivot field list. Fields dropped into this area will become filters that apply to the entire pivot grid.

Declaration

[Browsable(false)]
public RadListControl ReportFiltersControl { get; }

Property Value

Gets the RadListControl that displays and manages the row labels area of the pivot field list. Fields dropped into this area will become row headers in the pivot grid.

Declaration

[Browsable(false)]
public RadListControl RowLabelsControl { get; }

Property Value

Gets or sets the theme name applied to the pivot field list and all its child controls. Setting this property will recursively apply the theme to all Telerik controls within the field list.

Declaration

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

Property Value

Gets the RadListControl that displays and manages the values area of the pivot field list. Fields dropped into this area will become aggregated values in the pivot grid cells.

Declaration

[Browsable(false)]
public RadListControl ValuesControl { get; }

Property Value

Gets the view model that manages the data and logic for the pivot field list. The view model contains the collections for different field areas and handles field operations.

Declaration

[Browsable(false)]
public FieldListViewModel ViewModel { get; }

Property Value

Clean up any resources being used.

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides ContainerControl.Dispose(bool)

Gets the appropriate image icon for the specified field based on its role in the pivot structure. Different field roles (Dimension, Folder, Kpi, Measure, etc.) are represented by different icons.

Declaration

protected virtual Image GetImageForRole(IField field)

Parameters

Returns

Initializes the localized text for all UI elements in the pivot field list using the current localization provider. This method should be called when the localization settings change or when the control is first created.

Declaration

public void InitializeText()

Called when the data provider changes. This method synchronizes the view model's data provider with the current data provider and notifies the view model of the change to refresh the field list accordingly.

Declaration

protected virtual void OnDataProviderChanged()

Raises the Load event and performs additional initialization based on the current theme. This method handles special positioning adjustments for Metro Touch and Material themes.

Declaration

protected override void OnLoad(EventArgs e)

Parameters

Overrides UserControl.OnLoad(EventArgs)

Updates the position and size of the field list panels to distribute them evenly within the available space. This method calculates and sets the bounds for all four field areas (report filters, column labels, row labels, and values).

Declaration

protected virtual void UpdateFieldListsPosition()