ConstraintCollection.RemoveAt(Int32) Method

Definition

Namespace:

System.Data

Assembly:

System.Data.Common.dll

Source:

ConstraintCollection.cs

Removes the Constraint object at the specified index from the collection.

public:
 void RemoveAt(int index);

public void RemoveAt (int index);

member this.RemoveAt : int -> unit

Public Sub RemoveAt (index As Integer)

Parameters

index

Int32

The index of the Constraint to remove.

Exceptions

IndexOutOfRangeException

The collection does not have a constraint at this index.

Examples

The following example uses the IndexOf method together with the RemoveAt method to remove a constraint from the ConstraintCollection.

private void RemoveConstraint(ConstraintCollection constraints,
    Constraint constraint)
{
    try
    {
        if(constraints.Contains(constraint.ConstraintName))
        {
            if(constraints.CanRemove(constraint))
            {
                constraints.RemoveAt(constraints.IndexOf(
                    constraint.ConstraintName));
            }
        }
    }
    catch(Exception e)
    {
        // Process exception and return.
        Console.WriteLine("Exception of type {0} occurred.",
            e.GetType());
    }
}

Private Sub RemoveConstraint _
    (constraints As ConstraintCollection, constraint As Constraint)

    Try
        If constraints.Contains(constraint.ConstraintName) Then
            If constraints.CanRemove(constraint) Then
                constraints.RemoveAt _
                    (constraints.IndexOf(constraint.ConstraintName))
            End If
        End If

    Catch e As Exception
        ' Process exception and return.
        Console.WriteLine("Exception of type {0} occurred.", _
            e.GetType().ToString())
    End Try
End Sub

Remarks

The IndexOf method returns the index of a specific Constraint.

Before using the RemoveAt method, you can use the Contains method to determine whether the collection contains the target Constraint, and the CanRemove method to determine whether a Constraint can be removed.

The CollectionChanged event occurs if the constraint is successfully removed.

See also

• CanRemove(Constraint)
• Contains(String)
• IndexOf(Constraint)