Class FieldDefinitionCollection
A collection that stores FieldDefinition objects.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class FieldDefinitionCollection : CollectionBase, IList, ICollection, IEnumerable
Constructors
FieldDefinitionCollection()
Initializes a new instance of the FieldDefinitionCollection class.
Declaration
public FieldDefinitionCollection()
FieldDefinitionCollection(FieldDefinition[])
Initializes a new instance of the FieldDefinitionCollection class.
Declaration
public FieldDefinitionCollection(FieldDefinition[] value)
Parameters
Type | Name | Description |
---|---|---|
FieldDefinition[] | value | An array of FieldDefinition objects with which to intialize the collection |
FieldDefinitionCollection(FieldDefinitionCollection)
Initializes a new instance of the FieldDefinitionCollection class.
Declaration
public FieldDefinitionCollection(FieldDefinitionCollection value)
Parameters
Type | Name | Description |
---|---|---|
FieldDefinitionCollection | value | A FieldDefinitionCollection from which the contents are copied |
Properties
Item[Int32]
Gets / sets the field definition at the specified index of the FieldDefinition.
Declaration
public FieldDefinition this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index of the entry to locate in the collection. |
Property Value
Type | Description |
---|---|
FieldDefinition | The entry at the specified index of the collection. |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException |
|
Methods
Add(FieldDefinition)
Adds a FieldDefinition with the specified value to the FieldDefinitionCollection .
Declaration
public int Add(FieldDefinition value)
Parameters
Type | Name | Description |
---|---|---|
FieldDefinition | value | The FieldDefinition to add. |
Returns
Type | Description |
---|---|
System.Int32 | The index at which the new element was inserted. |
See Also
AddRange(FieldDefinition[])
Copies the elements of an array to the end of the FieldDefinitionCollection.
Declaration
public void AddRange(FieldDefinition[] value)
Parameters
Type | Name | Description |
---|---|---|
FieldDefinition[] | value | An array of type FieldDefinition containing the objects to add to the collection. |
See Also
AddRange(FieldDefinitionCollection)
Adds the contents of another FieldDefinitionCollection to the end of the collection.
Declaration
public void AddRange(FieldDefinitionCollection value)
Parameters
Type | Name | Description |
---|---|---|
FieldDefinitionCollection | value | A FieldDefinitionCollection containing the objects to add to the collection. |
See Also
Contains(FieldDefinition)
Indicates whether the FieldDefinitionCollection contains the specified FieldDefinition.
Declaration
public bool Contains(FieldDefinition value)
Parameters
Type | Name | Description |
---|---|---|
FieldDefinition | value | The FieldDefinition to locate. |
Returns
Type | Description |
---|---|
System.Boolean | true if the FieldDefinition is contained in the collection; false otherwise. |
See Also
CopyTo(FieldDefinition[], Int32)
Copies the FieldDefinitionCollection values to a one-dimensional System.Array instance at the specified index.
Declaration
public void CopyTo(FieldDefinition[] array, int index)
Parameters
Type | Name | Description |
---|---|---|
FieldDefinition[] | array | The one-dimensional System.Array that is the destination of the values copied from FieldDefinitionCollection . |
System.Int32 | index | The index in |
Exceptions
Type | Condition |
---|---|
System.ArgumentException |
-or- The number of elements in the FieldDefinitionCollection is greater than the available space between |
System.ArgumentNullException |
|
System.ArgumentOutOfRangeException |
|
See Also
GetEnumerator()
Returns an enumerator that can iterate through the FieldDefinitionCollection .
Declaration
public FieldDefinitionCollection.FieldDefinitionEnumerator GetEnumerator()
Returns
Type | Description |
---|---|
FieldDefinitionCollection.FieldDefinitionEnumerator | Returns FieldDefenition |
See Also
IndexOf(FieldDefinition)
Returns the index of a FieldDefinition in the FieldDefinitionCollection .
Declaration
public int IndexOf(FieldDefinition value)
Parameters
Type | Name | Description |
---|---|---|
FieldDefinition | value | The FieldDefinition to locate. |
Returns
Type | Description |
---|---|
System.Int32 | The index of the FieldDefinition of |
See Also
Insert(Int32, FieldDefinition)
Inserts a FieldDefinition into the FieldDefinitionCollection at the specified index.
Declaration
public void Insert(int index, FieldDefinition value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index where |
FieldDefinition | value | The FieldDefinition to insert. |
Remove(FieldDefinition)
Removes a specific FieldDefinition from the FieldDefinitionCollection .
Declaration
public void Remove(FieldDefinition value)
Parameters
Type | Name | Description |
---|---|---|
FieldDefinition | value | The FieldDefinition to remove from the FieldDefinitionCollection . |
Exceptions
Type | Condition |
---|---|
System.ArgumentException |
|