WPF

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PivotGridGroupingBar - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class PivotGridGroupingBar

    This is a helper class which is used to handle the PivotGrid GroupingBar events.

    Inheritance
    System.Object
    PivotGridGroupingBar
    Namespace: Syncfusion.Windows.Controls.PivotGrid
    Assembly: Syncfusion.PivotAnalysis.WPF.dll
    Syntax
    public class PivotGridGroupingBar : Control

    Constructors

    PivotGridGroupingBar()

    Initializes a new instance of the PivotGridGroupingBar class.

    Declaration
    public PivotGridGroupingBar()

    Fields

    AllowFilteringProperty

    Identifies the AllowFiltering dependency property.

    Declaration
    public static readonly DependencyProperty AllowFilteringProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    The identifier for the AllowFiltering dependency property.

    AllowMultiFunctionalSortFilterProperty

    Identifies the AllowMultiFunctionalSortFilter dependency property.

    Declaration
    public static readonly DependencyProperty AllowMultiFunctionalSortFilterProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    The identifier for the AllowMultiFunctionalSortFilter dependency property.

    AllowRemoveProperty

    Identifies the AllowRemove dependency property.

    Declaration
    public static readonly DependencyProperty AllowRemoveProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    The identifier for the AllowRemove dependency property.

    AllowSortingProperty

    Identifies the AllowSorting dependency property.

    Declaration
    public static readonly DependencyProperty AllowSortingProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    The identifier for the AllowSorting dependency property.

    BackgroundProperty

    Identifies the Background dependency property.

    Declaration
    public static readonly DependencyProperty BackgroundProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    The identifier for the Background dependency property.

    FieldListBorderBrushProperty

    Identifies the FieldListBorderBrush dependency property.

    Declaration
    public static readonly DependencyProperty FieldListBorderBrushProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    The identifier for the FieldListBorderBrush dependency property.

    FilterPopupProperty

    Identifies the Syncfusion.Windows.Controls.PivotGrid.PivotGroupingBar.FilterPopup dependency property.

    Declaration
    public static readonly DependencyProperty FilterPopupProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    The identifier for the Syncfusion.Windows.Controls.PivotGrid.PivotGroupingBar.FilterPopup dependency property.

    ItemsBackgroundProperty

    Identifies the ItemsBackground dependency property.

    Declaration
    public static readonly DependencyProperty ItemsBackgroundProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    The identifier for the ItemsBackground dependency property.

    ItemsBorderBrushProperty

    Identifies the ItemsBorderBrush dependency property.

    Declaration
    public static readonly DependencyProperty ItemsBorderBrushProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    The identifier for the ItemsBorderBrush dependency property.

    MultiFunctionalSortFilterPopupProperty

    Identifies the Syncfusion.Windows.Controls.PivotGrid.PivotGroupingBar.MultiFunctionalSortFilterPopup dependency property.

    Declaration
    public static readonly DependencyProperty MultiFunctionalSortFilterPopupProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    The identifier for the Syncfusion.Windows.Controls.PivotGrid.PivotGroupingBar.MultiFunctionalSortFilterPopup dependency property.

    Properties

    AllowFiltering

    Gets or sets whether filtering in GroupingBar is enabled or not.

    Declaration
    public bool AllowFiltering { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowMultiFunctionalSortFilter

    Gets or sets whether excel-like filtering in GroupingBar is enabled or not.

    Declaration
    public bool AllowMultiFunctionalSortFilter { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowRemove

    Gets or sets whether delete option in GroupingBar is enabled or not.

    Declaration
    public bool AllowRemove { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowSorting

    Gets or sets whether sorting in GroupingBar is enabled or not.

    Declaration
    public bool AllowSorting { get; set; }
    Property Value
    Type Description
    System.Boolean

    Background

    Gets or sets the GroupingBar's background color.

    Declaration
    public Brush Background { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush

    ButtonComputation

    Gets or sets the computation button.

    Declaration
    public Button ButtonComputation { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.Button

    CalculatedField

    Gets or sets the value in PivotComputationInfo.

    Declaration
    public CalculationField CalculatedField { get; }
    Property Value
    Type Description
    CalculationField

    ColumnHeaderArea

    Gets or sets the column header area of the Pivot Schema Designer, where column items are be located.

    Declaration
    public PivotGroupingItemsControl ColumnHeaderArea { get; set; }
    Property Value
    Type Description
    PivotGroupingItemsControl

    ComputationList

    Gets or sets the value indicating the PivotComputationInfo items in the PivotGrid ComputationList.

    Declaration
    public PivotGridComputationList ComputationList { get; }
    Property Value
    Type Description
    PivotGridComputationList

    CrossAnimatedGrid

    Gets the indicator when dragging an item from one place to other.

    Declaration
    public AnimatedGrid CrossAnimatedGrid { get; }
    Property Value
    Type Description
    AnimatedGrid

    DataHeaderArea

    Gets or sets the value header area of the Pivot Schema Designer, where calculation items are be located.

    Declaration
    public PivotGroupingItemsControl DataHeaderArea { get; set; }
    Property Value
    Type Description
    PivotGroupingItemsControl

    FieldList

    Gets or sets the value indicating the list of items in PivotGrid FieldList.

    Declaration
    public PivotGridFieldList FieldList { get; }
    Property Value
    Type Description
    PivotGridFieldList

    FieldListBorderBrush

    Gets or sets the field list border color.

    Declaration
    public Brush FieldListBorderBrush { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush

    FilterHeaderArea

    Gets or sets the filter header area of the Pivot Schema Designer, where filter items are be located.

    Declaration
    public PivotGroupingItemsControl FilterHeaderArea { get; set; }
    Property Value
    Type Description
    PivotGroupingItemsControl

    FilterPopup

    Gets or sets the pop-up which has list of filter items.

    Declaration
    public FilterPopup FilterPopup { get; set; }
    Property Value
    Type Description
    FilterPopup

    Filters

    Gets or sets the filters.

    Declaration
    public ObservableCollection<FilterItemsCollection> Filters { get; set; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<FilterItemsCollection>

    The filters.

    GridControl

    Gets or sets the PivotGrid control.

    Declaration
    public PivotGridControl GridControl { get; set; }
    Property Value
    Type Description
    PivotGridControl

    The PivotGrid control.

    IndicatorPopup

    Gets or sets the pop-up to indicate dragging operation.

    Declaration
    public Popup IndicatorPopup { get; }
    Property Value
    Type Description
    System.Windows.Controls.Primitives.Popup

    ItemsBackground

    Gets or sets the items background color.

    Declaration
    public Brush ItemsBackground { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush

    ItemsBorderBrush

    Gets or sets the items border color.

    Declaration
    public Brush ItemsBorderBrush { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush

    MultiFunctionalSortFilterPopup

    Gets or sets the multi-functional sort filter pop-up, which has similar sorting and filtering features like-in Excel.

    Declaration
    public MultiFunctionalSortFilterPopup MultiFunctionalSortFilterPopup { get; set; }
    Property Value
    Type Description
    MultiFunctionalSortFilterPopup

    RowHeaderArea

    Gets or sets the row header area of GroupingBar.

    Declaration
    public PivotGroupingItemsControl RowHeaderArea { get; set; }
    Property Value
    Type Description
    PivotGroupingItemsControl

    Methods

    ArrangeOverride(Size)

    An overridden method to arrange and size the content of a PivotGridGroupingBar object.

    Declaration
    protected override Size ArrangeOverride(Size arrangeBounds)
    Parameters
    Type Name Description
    System.Windows.Size arrangeBounds

    Computed size that is used to arrange the content.

    Returns
    Type Description
    System.Windows.Size

    Size of the control.

    CalculatedFieldCanExecute(Object, CanExecuteRoutedEventArgs)

    Can execute the CalculatedField visibility operation for the given command.

    Declaration
    public void CalculatedFieldCanExecute(object sender, CanExecuteRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.CanExecuteRoutedEventArgs e

    DeleteItemCanExecute(Object, CanExecuteRoutedEventArgs)

    Can execute the delete operation of the PivotItems for the given command.

    Declaration
    public void DeleteItemCanExecute(object sender, CanExecuteRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.CanExecuteRoutedEventArgs e

    DeleteItemExecuted(Object, ExecutedRoutedEventArgs)

    Executes the delete operation of the PivotItems for the given command.

    Declaration
    public void DeleteItemExecuted(object sender, ExecutedRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.ExecutedRoutedEventArgs e

    GetPivotItem(FilterItemsCollection)

    Creates a new PivotItem based on filter item.

    Declaration
    public PivotItem GetPivotItem(FilterItemsCollection filterItem)
    Parameters
    Type Name Description
    FilterItemsCollection filterItem
    Returns
    Type Description
    PivotItem

    GetPivotItem(PivotTableField)

    Creates a new PivotItem using the PivotTableField.

    Declaration
    public PivotItem GetPivotItem(PivotTableField pivotTableField)
    Parameters
    Type Name Description
    PivotTableField pivotTableField
    Returns
    Type Description
    PivotItem

    GetPivotItem(String)

    Creates a new PivotItem based on field name.

    Declaration
    public PivotItem GetPivotItem(string fieldName)
    Parameters
    Type Name Description
    System.String fieldName
    Returns
    Type Description
    PivotItem

    GetPivotItem(String, String)

    Creates a new PivotItem based on field name and field header.

    Declaration
    public PivotItem GetPivotItem(string fieldName, string fieldHeader)
    Parameters
    Type Name Description
    System.String fieldName
    System.String fieldHeader
    Returns
    Type Description
    PivotItem

    GetPivotItem(String, String, String, String, Boolean)

    Returns the PivotItem.

    Declaration
    public PivotItem GetPivotItem(string fieldName, string fieldCaption, string fieldHeader, string fieldFormat, bool fieldAllowGroup)
    Parameters
    Type Name Description
    System.String fieldName

    Name of the field.

    System.String fieldCaption

    The field caption

    System.String fieldHeader

    The field header.

    System.String fieldFormat

    The field format.

    System.Boolean fieldAllowGroup

    To enable or disable group by field at runtime.

    Returns
    Type Description
    PivotItem

    PivotItem.

    OnApplyTemplate()

    When overridden in a derived class, it is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

    Declaration
    public override void OnApplyTemplate()

    OrderCanExecute(Object, CanExecuteRoutedEventArgs)

    Can execute the sort order for the given command.

    Declaration
    public void OrderCanExecute(object sender, CanExecuteRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.CanExecuteRoutedEventArgs e

    OrderExecuted(Object, ExecutedRoutedEventArgs)

    Executes the sort order for the given command.

    Declaration
    public void OrderExecuted(object sender, ExecutedRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.ExecutedRoutedEventArgs e

    ReloadDataCanExecute(Object, CanExecuteRoutedEventArgs)

    Can execute data re-loading operation for the given command.

    Declaration
    public void ReloadDataCanExecute(object sender, CanExecuteRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.CanExecuteRoutedEventArgs e

    ReloadDataExecuted(Object, ExecutedRoutedEventArgs)

    Executes data re-loading operation for the given command.

    Declaration
    public void ReloadDataExecuted(object sender, ExecutedRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.ExecutedRoutedEventArgs e

    ShowCalculatedFieldExecuted(Object, ExecutedRoutedEventArgs)

    Executes the CalculatedField visibility operation for the given command.

    Declaration
    public void ShowCalculatedFieldExecuted(object sender, ExecutedRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.ExecutedRoutedEventArgs e

    ShowFieldListCanExecute(Object, CanExecuteRoutedEventArgs)

    Can execute the FieldList visibility operation for the given command.

    Declaration
    public void ShowFieldListCanExecute(object sender, CanExecuteRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.CanExecuteRoutedEventArgs e

    ShowFieldListExecuted(Object, ExecutedRoutedEventArgs)

    Executes the FieldList visibility operation for the given command.

    Declaration
    public void ShowFieldListExecuted(object sender, ExecutedRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.ExecutedRoutedEventArgs e

    ShowFilterCanExecute(Object, CanExecuteRoutedEventArgs)

    Can execute the FieldList visibility operation for the given command.

    Declaration
    public void ShowFilterCanExecute(object sender, CanExecuteRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.CanExecuteRoutedEventArgs e

    ShowFilterExecuted(Object, ExecutedRoutedEventArgs)

    Executes the filter visibility operation for the given command.

    Declaration
    public void ShowFilterExecuted(object sender, ExecutedRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.ExecutedRoutedEventArgs e

    SortPivotItemCanExecute(Object, CanExecuteRoutedEventArgs)

    Can execute the PivotItem's sorting operation for the given command.

    Declaration
    public void SortPivotItemCanExecute(object sender, CanExecuteRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.CanExecuteRoutedEventArgs e

    SortPivotItemExecuted(Object, ExecutedRoutedEventArgs)

    Executes the PivotItem's sorting operation for the given command.

    Declaration
    public void SortPivotItemExecuted(object sender, ExecutedRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.ExecutedRoutedEventArgs e

    ValueFilterMenuItemCanExecute(Object, CanExecuteRoutedEventArgs)

    Can execute the PivotItem's excel-like Label and Value filtering operation for the given command.

    Declaration
    public void ValueFilterMenuItemCanExecute(object sender, CanExecuteRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.CanExecuteRoutedEventArgs e

    ValueFilterMenuItemExecuted(Object, ExecutedRoutedEventArgs)

    Executes the PivotItem's excel-like Value and Label filtering operation for the given command.

    Declaration
    public void ValueFilterMenuItemExecuted(object sender, ExecutedRoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.ExecutedRoutedEventArgs e
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved