WinForms

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

    Show / Hide Table of Contents

    Class RecordChangedEventArgs

    Represents the class that provides data for SourceListRecordChanged and SourceListRecordChanging events that occur when a record in the underlying data source was added, removed, or changed.

    Inheritance
    System.Object
    SyncfusionCancelEventArgs
    RecordChangedEventArgs
    Inherited Members
    SyncfusionCancelEventArgs.ToString()
    Namespace: Syncfusion.Grouping
    Assembly: Syncfusion.Grouping.Base.dll
    Syntax
    public sealed class RecordChangedEventArgs : SyncfusionCancelEventArgs

    Constructors

    RecordChangedEventArgs(Record, RecordChangedType, Int32, Int32)

    Initializes a new instance of the RecordChangedEventArgs class.

    Declaration
    public RecordChangedEventArgs(Record record, RecordChangedType action, int newIndex, int oldIndex)
    Parameters
    Type Name Description
    Record record

    The affected record.

    RecordChangedType action

    Specifies how the record list changed.

    System.Int32 newIndex

    The new record index in the underlying data source; can be -1.

    System.Int32 oldIndex

    The old record index in the underlying data source; can be -1.

    RecordChangedEventArgs(Record, RecordChangedType, Int32, Int32, Group)

    Initializes a new instance of the RecordChangedEventArgs class.

    Declaration
    public RecordChangedEventArgs(Record record, RecordChangedType action, int newIndex, int oldIndex, Group group)
    Parameters
    Type Name Description
    Record record

    The affected record.

    RecordChangedType action

    Specifies how the record list changed.

    System.Int32 newIndex

    The new record index in the underlying data source; can be -1.

    System.Int32 oldIndex

    The old record index in the underlying data source; can be -1.

    Group group

    When a record is removed and a parent group needs to be removed, gets the group that is going to be removed.

    RecordChangedEventArgs(Record, RecordChangedType, Int32, Int32, Group, Boolean)

    Initializes a new instance of the RecordChangedEventArgs class.

    Declaration
    public RecordChangedEventArgs(Record record, RecordChangedType action, int newIndex, int oldIndex, Group group, bool sortAffected)
    Parameters
    Type Name Description
    Record record

    The affected record.

    RecordChangedType action

    Specifies how the record list changed.

    System.Int32 newIndex

    The new record index in the underlying data source; can be -1.

    System.Int32 oldIndex

    The old record index in the underlying data source; can be -1.

    Group group

    When a record is removed and a parent group needs to be removed, gets the group that is going to be removed.

    System.Boolean sortAffected

    Specifies if the sorted position of the changed record was changed.

    RecordChangedEventArgs(Record, RecordChangedType, Int32, Int32, Group, Boolean, TableListChangedEventArgs)

    Initializes a new instance of the RecordChangedEventArgs class.

    Declaration
    public RecordChangedEventArgs(Record record, RecordChangedType action, int newIndex, int oldIndex, Group group, bool sortAffected, TableListChangedEventArgs inner)
    Parameters
    Type Name Description
    Record record

    The affected record.

    RecordChangedType action

    Specifies how the record list changed.

    System.Int32 newIndex

    The new record index in the underlying data source; can be -1.

    System.Int32 oldIndex

    The old record index in the underlying data source; can be -1.

    Group group

    When a record is removed and a parent group needs to be removed, gets the group that is going to be removed.

    System.Boolean sortAffected

    Specifies if the sorted position of the changed record was changed.

    TableListChangedEventArgs inner

    Represents the boolean values.

    Properties

    Action

    Gets the value of how the record list changed.

    Declaration
    [TraceProperty(true)]
    public RecordChangedType Action { get; }
    Property Value
    Type Description
    RecordChangedType

    AddedGroup

    Gets or sets added group.

    Declaration
    [TraceProperty(true)]
    public Group AddedGroup { get; set; }
    Property Value
    Type Description
    Group
    Remarks

    The top-most group when a record was added with a new category.

    Group

    Gets or sets the affected group.

    Declaration
    [TraceProperty(true)]
    public Group Group { get; set; }
    Property Value
    Type Description
    Group
    Remarks

    The group which visibility is affected when a record is removed or added (if the affected record that is hidden is the only record or if a new group becomes visible which can also happen when a child record meets or fails to meet filter criteria)

    GroupsChanged

    Gets or sets the value indicating whether the changed record forces the changes to parent groups or not. Changes like moving record to new group or creating and deleting the record.

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

    IsNestedRelationParentKeyFieldAffected

    Gets or sets a value indicating whether the property was changed is the parent field of a master details relation or not.

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

    NewIndex

    Gets the new record index in the underlying data source; can be -1.

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

    OldIndex

    Gets the value of old record index in the underlying data source; can be -1.

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

    RaiseDisplayElementChanged

    Gets or sets the value indicating whether a DisplayElementChanged event should be raised after this event's handler returns or not.

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

    Record

    Gets the affected record.

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

    RemovedGroup

    Gets or sets the group to be removed.

    Declaration
    [TraceProperty(true)]
    public Group RemovedGroup { get; set; }
    Property Value
    Type Description
    Group
    Remarks

    When a record is removed and the parent group also needs to be removed.

    SortedPositionChanged

    Gets a value indicating whether the sorted position of the changed record was changed or not.

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

    TableListChangedEventArgs

    Gets or sets the value of the TableListChangedEventArgs instance.

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

    VisibilityChanged

    Gets or sets the value indicating whether the changed record visibility was changed or not irrespective of the filter meets criteria.

    Declaration
    [TraceProperty(true)]
    public bool VisibilityChanged { get; set; }
    Property Value
    Type Description
    System.Boolean
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved