WebPartManager.BeginWebPartEditing(WebPart) Method

Definition

Starts the process of editing a WebPart control.

public:
 virtual void BeginWebPartEditing(System::Web::UI::WebControls::WebParts::WebPart ^ webPart);
public virtual void BeginWebPartEditing (System.Web.UI.WebControls.WebParts.WebPart webPart);
abstract member BeginWebPartEditing : System.Web.UI.WebControls.WebParts.WebPart -> unit
override this.BeginWebPartEditing : System.Web.UI.WebControls.WebParts.WebPart -> unit
Public Overridable Sub BeginWebPartEditing (webPart As WebPart)

Parameters

webPart
WebPart

The control to be edited.

Exceptions

webPart is null.

The current display mode on the page is not EditDisplayMode.

webPart is closed.

-or-

webPart is not part of the Controls collection.

-or -

webPart is equal to the SelectedWebPart control.

Remarks

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.

Applies to

See also