EditorPartCollection.Contains Method (EditorPart)


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

Returns a value that indicates whether a particular control is in the collection.

Namespace:   System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

public bool Contains(
	EditorPart editorPart


Type: System.Web.UI.WebControls.WebParts.EditorPart

The EditorPart being tested for its status as a member of the collection.

Return Value

Type: System.Boolean

A Boolean value that indicates whether the EditorPart is in the collection.

The Contains method determines whether a specific EditorPart control is already in the EditorPartCollection object.

The following code example demonstrates how to determine whether a particular EditorPart control is in an EditorPartCollection object. For the full code required to run the example, see the Example section of the EditorPartCollection class overview.

The code in the Button1_Click event does not add the LayoutEditorPart1 control to the EditorPartCollection object when it adds the other controls. To confirm that the LayoutEditorPart1 control is not in the collection, the code uses the Contains method.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<script runat="server">

  protected void Button1_Click(object sender, EventArgs e)
    ArrayList list = new ArrayList(2);
    // Pass an ICollection object to the constructor.
    EditorPartCollection myParts = new EditorPartCollection(list);
    foreach (EditorPart editor in myParts)
      editor.BackColor = System.Drawing.Color.LightBlue;
      editor.Description = "My " + editor.DisplayTitle + " editor.";

    // Use the IndexOf property to locate an EditorPart control.
    int propertyGridPart = myParts.IndexOf(PropertyGridEditorPart1);
    myParts[propertyGridPart].ChromeType = PartChromeType.TitleOnly;

    // Use the Contains method to see if an EditorPart exists.
      LayoutEditorPart1.BackColor = System.Drawing.Color.LightYellow;

    // Use the CopyTo method to create an array of EditorParts.
    EditorPart[] partArray = new EditorPart[3];
    partArray[0] = LayoutEditorPart1;
    Label1.Text = "<h3>EditorParts in Custom Array</h3>";
    foreach (EditorPart ePart in partArray)
      Label1.Text += ePart.Title + "<br />";



When you load the page in a browser, you can switch the page into edit mode by selecting Edit in the Display Mode drop-down list control. You can click the verbs menu (the downward arrow) in the title bar of the TextDisplayWebPart control, and click Edit to edit the control. When the editing user interface (UI) is visible, you can see the all the EditorPart controls. If you click the Create EditorPartCollection button, you will notice that the background color of the LayoutEditorPart1 control is different from the other controls, because it is not part of the EditorPartCollection object.

.NET Framework
Available since 2.0
Return to top