Class DisplayElementChangingEventArgs

Represents the class that provides data for the DisplayElementChanging event that occurs before display elements in a table are changed. A GridGroupingControl listens to this event and deactivates the current cell and / or saves the cell's contents if necessary.

Inheritance
System.Object
SyncfusionCancelEventArgs
SyncfusionAllowCancelEventArgs
DisplayElementChangingEventArgs
Inherited Members
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public sealed class DisplayElementChangingEventArgs : SyncfusionAllowCancelEventArgs

Constructors

DisplayElementChangingEventArgs(Element, Int32, Int32, Boolean, Boolean, Boolean, Boolean)

Initializes a new instance of the DisplayElementChangingEventArgs contains the event data.

Declaration
public DisplayElementChangingEventArgs(Element element, int oldCount, int newCount, bool repaintElement, bool syncCurrentRecordPos, bool leaveCurrentRecord, bool scrollCurrentRecordInView)
Parameters
Type Name Description
Element element

The affected element can be the whole table.
System.Int32 oldCount

The old display element count of the affected element. Can be -1.
System.Int32 newCount

The new display element count of the affected element. Can be -1.
System.Boolean repaintElement

Indicates if element needs repainting.
System.Boolean syncCurrentRecordPos

Indicates if current record position should be saved and restored.
System.Boolean leaveCurrentRecord

Indicates if current record should be deactivated.
System.Boolean scrollCurrentRecordInView

Indicates if current record should be scrolled into view.

Properties

Element

Gets the affected element can be the whole table.

Declaration
[TraceProperty(true)]
public Element Element { get; }
Property Value
Type
Element

LeaveCurrentRecord

Gets the value indicating whether the current record should be deactivated or not.

Declaration
[TraceProperty(true)]
public bool LeaveCurrentRecord { get; set; }
Property Value
Type
System.Boolean

NewCount

Gets the new display element count of the affected element. Can be -1.

Declaration
[TraceProperty(true)]
public int NewCount { get; }
Property Value
Type
System.Int32

OldCount

Gets the old display element count of the affected element. Can be -1.

Declaration
[TraceProperty(true)]
public int OldCount { get; }
Property Value
Type
System.Int32

RepaintElement

Gets the value indicating whether the element needs repainting or not.

Declaration
[TraceProperty(true)]
public bool RepaintElement { get; }
Property Value
Type
System.Boolean

ScrollCurrentRecordInView

Gets the value indicating whether the current record should be scrolled into view or not.

Declaration
[TraceProperty(true)]
public bool ScrollCurrentRecordInView { get; }
Property Value
Type
System.Boolean

SyncCurrentRecordPos

Gets a value that indicates whether the current record position should be saved and restored or not.

Declaration
[TraceProperty(true)]
public bool SyncCurrentRecordPos { get; }
Property Value
Type
System.Boolean