Class AddNewRecordSection

Defines a class that adds a new record section to the table.

Inheritance
System.Object
Element
Section
DetailsSection
RecordsDetails
AddNewRecordSection
GridAddNewRecordSection
Inherited Members
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.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class AddNewRecordSection : RecordsDetails, IDisposable, IDisposedEvent, IIsDisposedProperty, ITreeTableCounterSource, ITreeTableSummaryArraySource, IContainerElement, IElementTreeTableSource, IElement
Remarks

This is the section within a group which provides the AddNewRecord that is shown above the table records and / or below the records for each group and implements logic to add new records. See the AddNewRecord class for more information.

The AddNewRecordSection is a RecordsDetails section and thus also a container element. Normally, a RecordsDetails section has a collection of one or multiple records but with a AddNewRecordSection you only have exactly one child record, the AddNewRecord.

If AddNewRecord(s) should be displayed at end of each group, then AddNewRecordSection(s) are created when the grouping for a table is initialized. The grouping engine loops through all sorted records and categorizes them. For each new group the virtual TableDescriptor.CreateGroup factory method is called. The TableDescriptor.CreateGroup method instantiates an AddNewRecordSection by calling the virtual TableDescriptor.CreateAddNewRecordSection factory method.

One AddNewRecord is displayed at the top of the table below the column headers. It belongs to the AddNewRecordSection of the TopLevelGroup of a table. The TopLevelGroup is created with the virtual TableDescriptor.CreateGroup factory method. The TableDescriptor.CreateGroup method instantiates an AddNewRecordSection by calling the virtual TableDescriptor.CreateAddNewRecordSection factory method.

Because the AddNewRecordSection is a container element and not a display element, it will not be an item returned by the Table.DisplayElements and Table.GroupedElements collection. Instead, AddNewRecordSection can be accessed only through the Group.Sections collection of its parent Group.

See also:

TableDescriptor.CreateGroup, TableDescriptor.CreateAddNewRecordSection, Table.TopLevelGroup, AddNewRecord, IContainerElement, Group.Sections.

Constructors

AddNewRecordSection(Group)

Initializes a new instance of the AddNewRecordSection class in the specified group.

Declaration
public AddNewRecordSection(Group parent)
Parameters
Type Name Description
Group parent

The group this section is created in.

Properties

AddNewRecord

Gets the value of reference to AddNewRecord.

Declaration
public AddNewRecord AddNewRecord { get; }
Property Value
Type Description
AddNewRecord

IsBeforeDetails

Gets or sets a value indicating whether this is the AddNewRecord that is shown above the DetailsSection or below.

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

Methods

ToString()

Returns a string that represents the current object.

Declaration
public override string ToString()
Returns
Type Description
System.String

A string holding the current object.
Overrides

Implements

System.IDisposable