ConstraintCollection.Remove 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.

Removes the Constraint object specified by name from the collection.

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

public void Remove(
	string name
)

Parameters

name
Type: System.String

The name of the Constraint to remove.

Before using the Remove 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.

The following example removes a Constraint from a ConstraintCollection after testing for its presence with the Contains method, and whether it can be removed with the CanRemove method.

private void RemoveConstraint(ConstraintCollection constraints, 
    Constraint constraint)
{
    if(constraints.Contains(constraint.ConstraintName))
        if(constraints.CanRemove(constraint))
            constraints.Remove(constraint.ConstraintName);
}

.NET Framework
Available since 1.1
Return to top
Show: