Fields Methods

Adds an IField to the collection.

Adds an object to the collection. Override. This method simply calls the Add method with CollectionAddFlags.replace as the flags.

Adds an item to the collection

Adds an item to the collection at the specified index. To append an item use -1 or the collection item count as the index.

Add a label to its associated field. The collection is scanned for a field whose ControlName matches the label's AssociatedControlID. If found, the field's label (LabelControl) is set to reference the label.

Clears the collection

Determines whether an element is in the collection.

Determines if a field with the specified Key exists in the collection.

Checks for the existence of an item in the hashtable

Copies the entire ArrayList to a compatible one-dimensional Array, starting at the beginning of the target array.

Determines whether the specified Object is equal to the current Object.

Retrieves the specified IField object from the collection. Note that, unlike the Fields[Key] indexer, if the field is not found then no entry is logged to the devlog. For finer control over behaviour when the field is not found, use the Find(String, FieldFindType, FindBehaviour) method specifying the desired FindBehaviour.

Retrieves the specified IField object from the collection. Note that, unlike the Fields[Key] indexer, if the field is not found no entry is logged to the devlog. For finer control over behaviour when the field is not found, use the Find(String, FieldFindType, FindBehaviour) method specifying the desired FindBehaviour.

Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

Searches for a field in the collection based on FieldFindType using OkIfNotFound. See Find(String, FieldFindType, FindBehaviour) for additional details.

Searches for an IField in the collection based on FieldFindType.

The searchID depends on the findType:

Get the value for the specified field, converted to a bool. The behaviour when the field is not found is dictated by the FindBehaviour parameter.

Get the value for the specified field, converted to a DateTime. The behaviour when the field is not found is dictated by the FindBehaviour parameter.

Get the value for the specified field, converted to a decimal. The behaviour when the field is not found is dictated by the FindBehaviour parameter.

The DisplayText (see cref="IField.DisplayTextGet"/>) for the specified field. The behaviour when the field is not found is dictated by the FindBehaviour parameter.

Get the value for the specified field, converted to a double. The behaviour when the field is not found is dictated by the FindBehaviour parameter.

Returns an enumerator that can iterate through the ArrayList.

Serves as a hash function for a particular type.

Get the value for the specified field, converted to an int. The behaviour when the field is not found is dictated by the FindBehaviour parameter.

Returns an item that matches the specified string index

Returns an item that matches the specified string index

Returns the name of the item, a IField.Key

Get the value for the specified field, converted to a string (without internationalization). The behaviour when the field is not found is dictated by the FindBehaviour parameter.

Gets the Type of the current instance.

Get the value for the specified field. If the field is not found then an error is raised.

Get the value for the specified field, or the defaultValue if not found. The behaviour when the field is not found is dictated by the FindBehaviour parameter.

Returns the zero-based index of the first occurrence of an object in the internal ArrayList or in a portion of it.

Returns the index of the item in the collection (by key)

Inserts an element into the internal ArrayList at the specified index

Determines if this element is marked for deletion. Note that this base implementation must be overridden in order to support RemoveMarkedItems() for a partular collection.

Verifies the item is an acceptable type. Generally this is a test like "return (item is [class]);".

Extracts the keys for the fields in the collection as a semi-colon separated list.

Creates a shallow copy of the current Object.

Send a notification to all fields in the collection.

Recalculates the internal hash

Removes the first occurrence of a specific object from the collection

Remove the specified item from the collection.

Removes the element at the specified index

Removes the properties marked for deletion.

Removes the element at the specified index

Sets an item's value at the specified index.

Sets an item's value at the string index indicated by the parameters.

Set the value for the specified field. If the field is not found, an error is raised.

Set the value for the specified field per the provided SetValFlags. Behaviour in the case where the specified field is not found in the collection is dictated by FindBehaviour.

Sort the list by its key value.

Sort the collection using the provided comparer.

Sorts the Fields collection in the order specified by the provided semi-colon-separated list of field keys. Fields not in the provided sort list retain their relative positions, but following all explicitly ordered fields. The list is handled case-insensitively, but may provide slightly better performance if provided in all lower-case.

Obtain a Fields collection with a subset of this collection's IField objects. The criteria for determining which fields to include in the subset is specified using FieldSubsetType:

• AttributeIsSet - Get the subset of fields where any of the specified set of FieldAttrs, provided in criteria, is set.
• ByCellType - Find all fields whose CellTypes matches the criteria.
• RowKeys - Get the subset of fields comprising the RowKeys for the mapper (criteria ignored).
• PropSet - Get the subset of fields where the specified property value, provided as a string in criteria, is not null/blank.
• Visible - Get the subset of fields with the specified Visible value, provided as a boolean in criteria.
• Dirty - Get the subset of fields with the specified Dirty value, provided as a boolean in criteria..

Returns a String that represents the current Object.

Truncate the array starting at the specified index.

Called when the collection is cleared allowing a derived class to clean up.

Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.