Export (0) Print
Expand All
Expand Minimize

WebPartManager.BeginWebPartEditing Method

Starts the process of editing a WebPart control.

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

public virtual void BeginWebPartEditing(
	WebPart webPart
)

Parameters

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

The control to be edited.

ExceptionCondition
ArgumentNullException

webPart is null.

InvalidOperationException

The current display mode on the page is not EditDisplayMode.

ArgumentException

webPart is closed.

- or -

webPart is not part of the Controls collection.

-or -

webPart is equal to the SelectedWebPart control.

The BeginWebPartEditing method exists so that the process of editing controls can be done in distinct stages, giving developers more control over the process. The method performs a set of initial checks to ensure that webPart is in a state where it can be edited. If webPart passes all the checks, it is then set as the currently selected control (see the SelectedWebPart property), and the editing process can continue.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0
Show:
© 2015 Microsoft