WinForms

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

    Show / Hide Table of Contents

    Class NestedTable

    Represents the class that implements the nested table inside a record.

    Inheritance
    System.Object
    Element
    NestedTable
    GridNestedTable
    Implements
    System.IDisposable
    ITreeTableCounterSource
    ITreeTableSummaryArraySource
    Inherited Members
    Element.SupportsId()
    Element.Dispose()
    Element.OnDisposed(EventArgs)
    Element.Dispose(Boolean)
    Element.EnsureInitialized(Object)
    Element.EnsureInitialized(Object, Boolean)
    Element.OnEnsureInitialized(Object)
    Element.GetCounter()
    Element.OnElementTreeInvalidateCounterBottomUp()
    Element.GetSummaries(Table)
    Element.GetSummaries(Table, Boolean)
    Element.InvalidateSummariesBottomUp()
    Element.GetCustomCount()
    Element.GetVisibleCustomCount()
    Element.IsChildVisible(Element)
    Element.GetVisibleInParent()
    Element.GetVisibleInHierarchy()
    Element.GetCustomPosition()
    Element.GetVisibleCustomPosition()
    Element.ITreeTableSummaryArraySource.GetSummaries(ITreeTableEmptySummaryArraySource, Boolean)
    Element.IsCaption(Element)
    Element.IsRecord(Element)
    Element.IsColumnHeader(Element)
    Element.IsFilterBar(Element)
    Element.IsCaption()
    Element.IsRecord()
    Element.IsColumnHeader()
    Element.IsFilterBar()
    Element.GetCaptionSection(Element)
    Element.GetRecord(Element)
    Element.GetColumnHeaderSection(Element)
    Element.GetFilterBar(Element)
    Element.GetCaptionSection()
    Element.GetRecord()
    Element.GetColumnHeaderSection()
    Element.GetFilterBar()
    Element.Engine
    Element.EngineTable
    Element.ParentTable
    Element.TableLevel
    Element.Id
    Element.Reserved1
    Element.Reserved2
    Element.Reserved3
    Element.Reserved4
    Element.Reserved5
    Element.Reserved6
    Element.Reserved7
    Element.Reserved8
    Element.Reserved9
    Element.Reserved10
    Element.Reserved11
    Element.Reserved16a
    Element.Reserved16b
    Element.Reserved16c
    Element.Info
    Element.Disposing
    Element.IsDisposed
    Element.InDisposed
    Element.ParentTableDescriptor
    Element.ParentElement
    Element.ParentDisplayElement
    Element.ParentGroup
    Element.ParentRecord
    Element.ParentChildTable
    Element.ParentSection
    Element.GroupLevel
    Element.ChildTableGroupLevel
    Element.Disposed
    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 NestedTable : Element, IDisposable, IDisposedEvent, IIsDisposedProperty, ITreeTableCounterSource, ITreeTableSummaryArraySource, IContainerElement, IElementTreeTableSource, IElement
    Remarks

    You can access nested tables in a record with the NestedTables property of a Record. Each nested table has a ChildTable that provides a link to the to the child records in a related table.

    Constructors

    NestedTable(RecordNestedTablesPart)

    Initializes a new instance of the NestedTable with the specified parent.

    Declaration
    public NestedTable(RecordNestedTablesPart parent)
    Parameters
    Type Name Description
    RecordNestedTablesPart parent

    An instance of the RecordNestedTablesPart class.

    Properties

    ChildTable

    Gets a link to the to the child records in a related table.

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

    FilteredRecords

    Gets the filtered records form the FilteredRecordsInDetailsCollection that meets filter criteria.

    Declaration
    public FilteredRecordsInDetailsCollection FilteredRecords { get; }
    Property Value
    Type Description
    FilteredRecordsInDetailsCollection
    Remarks

    ShortCut for ((RecordsDetails) Details).FilteredRecords. This returns only records in the group that meet filter criteria.

    Groups

    Gets the values of the group in the GroupsInDetailsCollection.

    Declaration
    public GroupsInDetailsCollection Groups { get; }
    Property Value
    Type Description
    GroupsInDetailsCollection
    Remarks

    ShortCut for ((GroupsDetails) Details).Groups. A group can either be a final node with records or it can be a node with nested groups. If a group has records, its Groups collection will be empty and the Records collection will contain all records. If a group has nested groups, its Groups collection will have the nested groups and the Records collection will be empty.

    IsExpanded

    Gets or sets the value indicating whether the child table with child records is in expanded state or not.

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

    True if the child table is in expanded state;Otherwise False if it is in collapsed state.

    Kind

    Gets the element kind.

    Declaration
    public override DisplayElementKind Kind { get; }
    Property Value
    Type Description
    DisplayElementKind
    Overrides
    Element.Kind

    Records

    Gets the value of all records from the RecordsInDetailsCollection irrespective of records that meets filter criteria.

    Declaration
    public RecordsInDetailsCollection Records { get; }
    Property Value
    Type Description
    RecordsInDetailsCollection
    Remarks

    ShortCut for ((RecordsDetails) Details).Records. This returns all records in the group including records that do not meet filter criteria.

    Methods

    GetChildCount()

    Overridden to get the number of child.

    Declaration
    public override int GetChildCount()
    Returns
    Type Description
    System.Int32

    Child count.

    Overrides
    Element.GetChildCount()

    GetData()

    Overridden to get the data of the given record.

    Declaration
    public override object GetData()
    Returns
    Type Description
    System.Object

    Returns Null value.

    Overrides
    Element.GetData()

    GetElementCount()

    Overridden to gets the number of elements.

    Declaration
    public override int GetElementCount()
    Returns
    Type Description
    System.Int32

    Element count.

    Overrides
    Element.GetElementCount()

    GetFilteredRecordCount()

    Overridden to get the number of filtered records.

    Declaration
    public override int GetFilteredRecordCount()
    Returns
    Type Description
    System.Int32

    Filtered record count.

    Overrides
    Element.GetFilteredRecordCount()

    GetRecordCount()

    Overridden to get the number of records.

    Declaration
    public override int GetRecordCount()
    Returns
    Type Description
    System.Int32

    Record count.

    Overrides
    Element.GetRecordCount()

    GetVisibleCount()

    Overridden to get the number of visible elements.

    Declaration
    public override int GetVisibleCount()
    Returns
    Type Description
    System.Int32

    Visible element count.

    Overrides
    Element.GetVisibleCount()

    GetYAmountCount()

    Overridden to get the row height of the given element.

    Declaration
    public override double GetYAmountCount()
    Returns
    Type Description
    System.Double

    Element's row height.

    Overrides
    Element.GetYAmountCount()

    InvalidateCounter()

    Overridden to reset the counter.

    Declaration
    public override void InvalidateCounter()
    Overrides
    Element.InvalidateCounter()

    InvalidateCounterBottomUp()

    Overridden to reset the counter for all elements from bottom to top.

    Declaration
    public override void InvalidateCounterBottomUp()
    Overrides
    Element.InvalidateCounterBottomUp()

    InvalidateCounterTopDown(Boolean)

    Overridden to resets the counter for all elements from top to bottom.

    Declaration
    public override void InvalidateCounterTopDown(bool notifyCounterSource)
    Parameters
    Type Name Description
    System.Boolean notifyCounterSource

    When true notifies the counter source.

    Overrides
    Element.InvalidateCounterTopDown(Boolean)

    InvalidateSummariesTopDown()

    Overridden to reset the summary for all elements from top to bottom.

    Declaration
    public override void InvalidateSummariesTopDown()
    Overrides
    Element.InvalidateSummariesTopDown()

    InvalidateSummary()

    Overridden to reset the summaries.

    Declaration
    public override void InvalidateSummary()
    Overrides
    Element.InvalidateSummary()

    OnBeginEditCalled()

    Overridden to determine whether the BeginEdit() method is called or not.

    Declaration
    public override bool OnBeginEditCalled()
    Returns
    Type Description
    System.Boolean

    True if BeginEdit() can proceed; Otherwise False and it gets aborted.

    Overrides
    Element.OnBeginEditCalled()

    OnBeginEditComplete(Boolean)

    Overridden and occurs when the BeginEdit() method successfully finishes.

    Declaration
    public override void OnBeginEditComplete(bool success)
    Parameters
    Type Name Description
    System.Boolean success

    True, if it is successfully finished; Otherwise False.

    Overrides
    Element.OnBeginEditComplete(Boolean)

    OnCancelEditCalled()

    Overridden to determine whether the CancelEdit() method is called or not.

    Declaration
    public override bool OnCancelEditCalled()
    Returns
    Type Description
    System.Boolean

    True if CancelEdit() can proceed; Otherwise False and it gets aborted.

    Overrides
    Element.OnCancelEditCalled()

    OnCancelEditComplete(Boolean)

    Overridden and occurs when the CancelEdit() method successfully finishes.

    Declaration
    public override void OnCancelEditComplete(bool success)
    Parameters
    Type Name Description
    System.Boolean success

    Trueif it is successfully finished; Otherwise False.

    Overrides
    Element.OnCancelEditComplete(Boolean)

    OnEndEditCalled()

    Overridden to determine whether the EndEdit() method is called or not.

    Declaration
    public override bool OnEndEditCalled()
    Returns
    Type Description
    System.Boolean

    True if EndEdit() can proceed; Otherwise False it gets aborted.

    Overrides
    Element.OnEndEditCalled()

    OnEndEditComplete(Boolean)

    Overridden and occurs when the EndEdit() method successfully finishes.

    Declaration
    public override void OnEndEditComplete(bool success)
    Parameters
    Type Name Description
    System.Boolean success

    True, if it is successfully finished; Otherwise False.

    Overrides
    Element.OnEndEditComplete(Boolean)

    OnEnterRecordCalled()

    Overridden to determine whether theEnterRecord(Element) method is called or not.

    Declaration
    public override bool OnEnterRecordCalled()
    Returns
    Type Description
    System.Boolean

    True if the EnterRecord(Element) can proceed; Otherwise False and it gets aborted.

    Overrides
    Element.OnEnterRecordCalled()

    OnEnterRecordComplete(Boolean)

    Overridden and occurs when the EnterRecord(Element) method successfully finishes.

    Declaration
    public override void OnEnterRecordComplete(bool success)
    Parameters
    Type Name Description
    System.Boolean success

    Trueif it is successfully finished; Otherwise False.

    Overrides
    Element.OnEnterRecordComplete(Boolean)

    OnLeaveRecordCalled()

    Overridden to determine whether the LeaveRecord(Boolean) method is called or not.

    Declaration
    public override bool OnLeaveRecordCalled()
    Returns
    Type Description
    System.Boolean

    True if the LeaveRecord(Boolean) can proceed; Otherwise False and it gets aborted.

    Overrides
    Element.OnLeaveRecordCalled()

    OnLeaveRecordComplete(Boolean)

    Overridden and occurs when the LeaveRecord(Boolean) method successfully finishes.

    Declaration
    public override void OnLeaveRecordComplete(bool success)
    Parameters
    Type Name Description
    System.Boolean success

    True if it is successfully finished; Otherwise False.

    Overrides
    Element.OnLeaveRecordComplete(Boolean)

    ToString()

    Overridden to get the string representation of the current object.

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

    String representation of the current object.

    Overrides
    Element.ToString()

    Implements

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