WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PivotEngineUpdatingManager

    Show / Hide Table of Contents

    Class PivotEngineUpdatingManager

    This class allows a PivotEngine to automatically respond to changes in the underlying data provided that data supports appropriate events.

    Inheritance
    System.Object
    PivotEngineUpdatingManager
    PivotUpdatingManager
    Implements
    System.IDisposable
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.PivotAnalysis.Base
    Assembly: Syncfusion.PivotAnalysis.Base.dll
    Syntax
    public class PivotEngineUpdatingManager : IDisposable
    Remarks

    In order for the PivotEngine to automatically respond to the changes in the underlying data, the underlying data must be either: A) a DataTable or DataView or B) an IList<T> where T implements both INotifyPropertyChanging and INotifyPropertyChanged. Additionally, the IList must also implement INotifyCollectionChanged or IBindingList."

    Constructors

    PivotEngineUpdatingManager(PivotEngine)

    Initializes a new instance of the PivotEngineUpdatingManager class with the specified PivotEngine.

    Declaration
    public PivotEngineUpdatingManager(PivotEngine pivotEngine)
    Parameters
    Type Name Description
    PivotEngine pivotEngine

    The PivotEngine that should be responding to updates.

    Properties

    Engine

    Gets the PivotEngine value Used internally

    Declaration
    protected PivotEngine Engine { get; }
    Property Value
    Type Description
    PivotEngine

    Methods

    ChangeValue(Object, Object, Object, String, Int32, Int32, Boolean, Boolean)

    Override this method to control how the changes affect the pivot display. The base implementation calls IAdjustable methods on the summaries to accomplish the change.

    Declaration
    protected virtual void ChangeValue(object oldValue, object newValue, object item, string propertyName, int row, int col, bool adjustAdd, bool adjustRemove)
    Parameters
    Type Name Description
    System.Object oldValue

    The previous value of the changed property.

    System.Object newValue

    The new value of the changed property.

    System.Object item

    The object that holds the changed property.

    System.String propertyName

    The property name that was changed.

    System.Int32 row

    The row index in the PivotEngine that is affected by the change.

    System.Int32 col

    The column index in the PivotEngine that is affected by the change.

    System.Boolean adjustAdd

    If true, the IAdjustable.AdjustForNewContribution on the Summary for this row/column is called to make the adjustment.

    System.Boolean adjustRemove

    If true, the IAdjustable.AdjustForOldContribution on the Summary for this row/column is called to make the adjustment.

    CheckUpdateCell(Int32, Int32)

    CheckUpdateCell method used to refresh the cell

    Declaration
    protected virtual void CheckUpdateCell(int row, int col)
    Parameters
    Type Name Description
    System.Int32 row

    The row index of the cell

    System.Int32 col

    The column index of the cell

    Dispose()

    Clears the instances that were subscribed to when this object was created.

    Declaration
    public void Dispose()

    Dispose(Boolean)

    Unsubscribe to certain events that were subscribed to when this object was created.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    InitalizeUpdatingManager(PivotEngine)

    Initializes the updating manager with its associated settings.

    Declaration
    protected void InitalizeUpdatingManager(PivotEngine engine)
    Parameters
    Type Name Description
    PivotEngine engine

    The PivotEngine object

    Item_PropertyChanged(Object, PropertyChangedEventArgs)

    Override this method to catch the previous values of an underlying object after a change is applied. This method is the default handler for the object's PropertyChange event. The base implementation calls the ChangeValue method to respond to the changed value.

    Declaration
    protected virtual void Item_PropertyChanged(object sender, PropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The object that is changing.

    System.ComponentModel.PropertyChangedEventArgs e

    The System.ComponentModel.PropertyChangedEventArgscontains the event data.

    item_PropertyChanging(Object, PropertyChangingEventArgs)

    Override this method to catch the previous values of an underlying object before a change is applied. This method is the default handler for the object's PropertyChanging event.

    Declaration
    protected virtual void item_PropertyChanging(object sender, PropertyChangingEventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The object that is changing.

    System.ComponentModel.PropertyChangingEventArgs e

    The System.ComponentModel.PropertyChangingEventArgscontains the event data.

    PopulateEngine()

    Populate the engine value based on current dataSource values

    Declaration
    protected virtual void PopulateEngine()

    UnwireEvents()

    UnWire the events from the PivotEngine.

    Declaration
    protected virtual void UnwireEvents()

    UpdateRefreshHelper_CollectionChanged(Object, NotifyCollectionChangedEventArgs)

    Override this method to control the response to a collection changed event for a list that implements the ICollectionChanged.

    Declaration
    protected virtual void UpdateRefreshHelper_CollectionChanged(object sender, NotifyCollectionChangedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The ICollectionChanged collection.

    System.Collections.Specialized.NotifyCollectionChangedEventArgs e

    The System.Collections.Specialized.NotifyCollectionChangedEventArgscontains the event data.

    UpdateRefreshHelper_ListChanged(Object, ListChangedEventArgs)

    Override this method to control the response to a list changed event for a list that implements System.ComponentModel.IBindingList.

    Declaration
    protected virtual void UpdateRefreshHelper_ListChanged(object sender, ListChangedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The IBindingList.

    System.ComponentModel.ListChangedEventArgs e

    The System.ComponentModel.ListChangedEventArgscontains the event data.

    WireEvents()

    Unsubscribe to certain events that were subscribed to when this object was created.

    Declaration
    public void WireEvents()

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved