WebPartManager.CreateDynamicWebPartID(Type) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Generates a unique ID for a dynamic WebPart control.

protected:
 virtual System::String ^ CreateDynamicWebPartID(Type ^ webPartType);

protected virtual string CreateDynamicWebPartID (Type webPartType);

abstract member CreateDynamicWebPartID : Type -> string
override this.CreateDynamicWebPartID : Type -> string

Protected Overridable Function CreateDynamicWebPartID (webPartType As Type) As String

Parameters

webPartType: Type

The Type of the control for which an ID is being generated.

Returns

String

A string that contains the unique ID for a control.

Exceptions

ArgumentNullException

webPartType is null.

Remarks

When WebPart controls are added to a Web page, they can be static (which means the control is declared in the page markup) or dynamic (which means they are added programmatically). In any scenario where the WebPartManager control is creating new dynamic controls to add to the page, it calls this method to generate a unique ID.

The method is virtual so that developers can override it if they want to provide a custom implementation for generating the ID.

Applies to

Dela via