Class GroupDisplayElements
Represents a class which contains the information of the group and its records.
Inheritance
Implements
Namespace: Syncfusion.Data
Assembly: Syncfusion.Data.WPF.dll
Syntax
public class GroupDisplayElements : Object, IDisposable, IList<NodeEntry>, ICollection<NodeEntry>, IEnumerable<NodeEntry>, IEnumerable
Constructors
GroupDisplayElements(TopLevelGroup)
Initializes a new instance of the GroupDisplayElements class.
Declaration
public GroupDisplayElements(TopLevelGroup group)
Parameters
Type | Name | Description |
---|---|---|
TopLevelGroup | group | The corresponding group whose display elements are initialized. |
Properties
Count
Gets the total number of display elements contained in the top-level group.
Declaration
public int Count { get; }
Property Value
Type | Description |
---|---|
System.Int32 | The total number of display elements contained in the top-level group. |
IsReadOnly
Gets a boolean value indicating whether the list of node entry in the top-level group is read-only.
Declaration
public bool IsReadOnly { get; }
Property Value
Type | Description |
---|---|
System.Boolean | True if the list of node entry in the top-level group is read-only, otherwise false. |
Item[Int32]
Gets or sets the NodeEntry at the specified index.
Declaration
public NodeEntry this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index |
Property Value
Type | Description |
---|---|
NodeEntry | The NodeEntry at the specified index. |
TopLevelGroup
Gets the top-level group of the current group's display elements.
Declaration
public TopLevelGroup TopLevelGroup { get; }
Property Value
Type | Description |
---|---|
TopLevelGroup | The top-level group of the current group's display elements. |
Methods
Add(NodeEntry)
Adds the given item to the list of node entry in the top-level group.
Declaration
public void Add(NodeEntry item)
Parameters
Type | Name | Description |
---|---|---|
NodeEntry | item | The item to be added. |
Add(NodeEntry, Boolean)
Adds an item to the System.Collections.Generic.ICollection<>.
Declaration
public void Add(NodeEntry item, bool isInSourceCollectionChange)
Parameters
Type | Name | Description |
---|---|---|
NodeEntry | item | The object to add to the System.Collections.Generic.ICollection<>. |
System.Boolean | isInSourceCollectionChange | A boolean value indicating whether the source collection change is currently in progress. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The System.Collections.Generic.ICollection<> is read-only. |
System.InvalidOperationException | Item has to be of type RecordEntry |
Clear()
Clears all the items in the group.
Declaration
public void Clear()
Contains(NodeEntry)
Determines whether the specific item is found in the list of items in the group.
Declaration
public bool Contains(NodeEntry item)
Parameters
Type | Name | Description |
---|---|---|
NodeEntry | item | The object to locate in the list of items in the group. |
Returns
Type | Description |
---|---|
System.Boolean | True if |
CopyTo(NodeEntry[], Int32)
Copies the elements of the System.Collections.Generic.ICollection<> to an System.Array, starting at a particular System.Array index.
Declaration
public void CopyTo(NodeEntry[] array, int arrayIndex)
Parameters
Type | Name | Description |
---|---|---|
NodeEntry[] | array | The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Generic.ICollection<>. The System.Array must have zero-based indexing. |
System.Int32 | arrayIndex | The zero-based index in |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
System.ArgumentOutOfRangeException |
|
System.ArgumentException |
|
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public void Dispose()
Dispose(Boolean)
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
protected virtual void Dispose(bool isDisposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | isDisposing | Indicates whether the call is from dispose method or from a finalizer. |
GetEnumerator()
Returns an enumerator that iterates through the collection of items in the group.
Declaration
public IEnumerator<NodeEntry> GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerator<NodeEntry> | A System.Collections.Generic.IEnumerator<> that can be used to iterate through the collection of items in the group. |
GetItem(Object)
Gets the corresponding node entry of the given item.
Declaration
public NodeEntry GetItem(object item)
Parameters
Type | Name | Description |
---|---|---|
System.Object | item | The item whose node entry is to be obtained. |
Returns
Type | Description |
---|---|
NodeEntry | Returns the corresponding node entry of the given item. |
GetItemAt(Int32)
Gets the node entry of the item at the given index.
Declaration
protected virtual NodeEntry GetItemAt(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The index at which the node entry is to be obtained. |
Returns
Type | Description |
---|---|
NodeEntry | The item at the given index. |
IndexOf(NodeEntry)
Determines the index of a specific item in the list of items in view of the top-level group.
Declaration
public int IndexOf(NodeEntry item)
Parameters
Type | Name | Description |
---|---|---|
NodeEntry | item | The object to locate in the list of items in view of the top-level group. |
Returns
Type | Description |
---|---|
System.Int32 | The index of |
IndexOf(Object)
Gets the index of given item in the list of items in the top-level group.
Declaration
public int IndexOf(object item)
Parameters
Type | Name | Description |
---|---|---|
System.Object | item | The item whose index is to be obtained. |
Returns
Type | Description |
---|---|
System.Int32 | Returns the index of given item in the top-level group. |
Insert(Int32, NodeEntry)
Inserts the given item at the specified index to the list of items in the group.
Declaration
public void Insert(int index, NodeEntry item)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index at which |
NodeEntry | item | The object to be inserted. |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException |
|
System.NotSupportedException | The System.Collections.Generic.IList<> is read-only. |
InsertRecord(NodeEntry, Int32, Boolean)
Inserts the given item at the specified index in the group.
Declaration
public void InsertRecord(NodeEntry item, int index, bool isInSourceCollectionChange)
Parameters
Type | Name | Description |
---|---|---|
NodeEntry | item | The item to be inserted. |
System.Int32 | index | The index at which the item is to be inserted. |
System.Boolean | isInSourceCollectionChange | A boolean value indicating whether the source collection change is currently in progress. |
IsEntryInView(NodeEntry)
Gets or sets a boolean value indicating whether the given node entry is in view.
Declaration
public bool IsEntryInView(NodeEntry entry)
Parameters
Type | Name | Description |
---|---|---|
NodeEntry | entry | The node entry which is to be queried in the view. |
Returns
Type | Description |
---|---|
System.Boolean | A boolean value indicating whether the given node entry is in view. |
Remove(NodeEntry)
Removes the first occurrence of a specific object from the list of items in the group.
Declaration
public bool Remove(NodeEntry item)
Parameters
Type | Name | Description |
---|---|---|
NodeEntry | item | The object to be removed. |
Returns
Type | Description |
---|---|
System.Boolean | True if |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The System.Collections.Generic.ICollection<> is read-only. |
RemoveAt(Int32)
Removes the corresponding item at the specified index from the list of items in the group.
Declaration
public void RemoveAt(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index of the item to remove. |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException |
|
System.NotSupportedException | The System.Collections.Generic.IList<> is read-only. |
RemoveNode(NodeEntry, Boolean)
Removes the first occurrence of a specific object from the list of items in the group.
Declaration
public int RemoveNode(NodeEntry item, bool isInSourceCollectionChange)
Parameters
Type | Name | Description |
---|---|---|
NodeEntry | item | The object to be removed. |
System.Boolean | isInSourceCollectionChange | A boolean value indicating whether the source collection change is currently in progress. |
Returns
Type | Description |
---|---|
System.Int32 | Gets the index at which the item is removed. |