WebPartCollection::Item Property (String^)

 

Returns a member of the collection based on a unique string identifier.

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

public:
property WebPart^ default[
	String^ id
] {
	WebPart^ get(String^ id);
}

Parameters

id
Type: System::String^

The unique identifier for a particular WebPart control in a collection.

Property Value

Type: System.Web.UI.WebControls.WebParts::WebPart^

The first WebPart in the collection whose ID equals the value of id.

The Item indexer enables you to access a WebPart control in a WebPartCollection object according to a unique identifier.

System_CAPS_noteNote

The Web Parts control set performs case-insensitive matching on this property, so case sensitivity is not part of a unique id value.

The Item property also works to identify members of a WebPartCollection object in some specialized cases. In the case of GenericWebPart controls, the indexer is able to match the identifier for the underlying child control wrapped by the GenericWebPart control. In the case of ProxyWebPart controls, the indexer matches the identifier for the control based on a case-insensitive comparison of the id parameter and either the OriginalID or GenericWebPartID property values.

.NET Framework
Available since 2.0
Return to top
Show: