ConstraintCollection.IndexOf Method (String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the index of the Constraint specified by name.

Namespace:   System.Data
Assembly:  System.Data (in System.Data.dll)

public int IndexOf(
	string constraintName
)

Parameters

constraintName
Type: System.String

The name of the Constraint.

Return Value

Type: System.Int32

The index of the Constraint if it is in the collection; otherwise, -1.

Use the IndexOf method to return an index to be used with either the Contains or Remove method.

The following example uses the IndexOf method to return the index of a Constraint. The index is passed to the Contains method to determine whether the collection contains the constraint, before removing it.

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());
    }
}

.NET Framework
Available since 1.1
Return to top
Show: