Class ExpressionFieldDescriptorCollection
A collection of ExpressionFieldDescriptor fields with run-time formula expressions. An instance of this collection is returned by the ExpressionFields property of a TableDescriptor.
Implements
Inherited Members
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class ExpressionFieldDescriptorCollection : FieldDescriptorCollection, IDisposable, IList, ICollection, IEnumerable, IInsideCollectionEditorProperty, ICloneable, ICustomTypeDescriptorConstructors
ExpressionFieldDescriptorCollection()
Initializes a new instance of the ExpressionFieldDescriptorCollection class.
Declaration
public ExpressionFieldDescriptorCollection()Fields
Empty
A Read-only and empty collection.
Declaration
public static readonly ExpressionFieldDescriptorCollection EmptyField Value
| Type |
|---|
| ExpressionFieldDescriptorCollection |
Properties
Item[Int32]
Gets or sets the element at the zero-based index.
Declaration
public ExpressionFieldDescriptor this[int index] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index |
Property Value
| Type |
|---|
| ExpressionFieldDescriptor |
Item[String]
Gets or sets the element with the specified name.
Declaration
public ExpressionFieldDescriptor this[string name] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name |
Property Value
| Type |
|---|
| ExpressionFieldDescriptor |
Methods
AddRange(ExpressionFieldDescriptor[])
Adds multiple elements at the end of the collection.
Declaration
public void AddRange(ExpressionFieldDescriptor[] values)Parameters
| Type | Name | Description |
|---|---|---|
| ExpressionFieldDescriptor[] | values | The array whose elements should be added to the end of the collection. The array and its elements cannot be NULL references (Nothing in Visual Basic). |
CheckType(Object)
Ensure type correctness when a new element is added to the collection.
Declaration
protected override void CheckType(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | The newly added object. |
Overrides
Clone()
Creates a copy of the collection and all its elements.
Declaration
public ExpressionFieldDescriptorCollection Clone()Returns
| Type | Description |
|---|---|
| ExpressionFieldDescriptorCollection | A copy of the collection and all its elements. |
CopyTo(ExpressionFieldDescriptor[], Int32)
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
Declaration
public void CopyTo(ExpressionFieldDescriptor[] array, int index)Parameters
| Type | Name | Description |
|---|---|---|
| ExpressionFieldDescriptor[] | array | The one-dimensional array that is the destination of the elements copied from ArrayList. The array must have zero-based indexing. |
| System.Int32 | index | The zero-based index in array at which copying begins. |
CreateCollection(TableDescriptor, FieldDescriptor[])
Called from InternalClone to create a new collection and attach it to the specified table descriptor and insert the specified fields. The fields have already been cloned.
Declaration
protected override FieldDescriptorCollection CreateCollection(TableDescriptor td, FieldDescriptor[] columnDescriptors)Parameters
| Type | Name | Description |
|---|---|---|
| TableDescriptor | td | The table descriptor. |
| FieldDescriptor[] | columnDescriptors | The cloned field descriptors. |
Returns
| Type | Description |
|---|---|
| FieldDescriptorCollection | A new FieldDescriptorCollection. |
Overrides
EnsureInitialized(Boolean)
Ensures the collection is initialized and auto-populates the collection on demand.
Declaration
protected override void EnsureInitialized(bool populate)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | populate | True if collection should auto-populate itself based on properties of the underlying data source. |
Overrides
Equals(Object)
Compares two descriptor values.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | The given object. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the descriptors are equivalent; False otherwise. |
Overrides
GetEnumerator()
Returns an enumerator for the entire collection.
Declaration
public ExpressionFieldDescriptorCollectionEnumerator GetEnumerator()Returns
| Type | Description |
|---|---|
| ExpressionFieldDescriptorCollectionEnumerator | An Enumerator for the entire collection. |
Remarks
Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection.
GetHashCode()
Serves as a hash function.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 | Returns hash code. |
Overrides
SuggestName(FieldDescriptor)
Called to get a new default name when a new field descriptor is created (e.g. when pressing "Add" in a collection editor).
Declaration
protected override void SuggestName(FieldDescriptor value)Parameters
| Type | Name | Description |
|---|---|---|
| FieldDescriptor | value | The field descriptor to be named. |