WebPartAddingEventArgs Class

Definition

Provides data for the WebPartAdding event.

public ref class WebPartAddingEventArgs : System::Web::UI::WebControls::WebParts::WebPartCancelEventArgs
public class WebPartAddingEventArgs : System.Web.UI.WebControls.WebParts.WebPartCancelEventArgs
type WebPartAddingEventArgs = class
    inherit WebPartCancelEventArgs
Public Class WebPartAddingEventArgs
Inherits WebPartCancelEventArgs
Inheritance

Remarks

The WebPartAdding event is raised by the OnWebPartAdding method just before adding a control to a Web Parts zone. This event provides an opportunity to cancel the process before it is complete. The WebPartAdded event is called after a control has been added to a Web Parts zone.

The WebPartAddingEventArgs class contains information that can be used within a WebPartAdding event. It provides access to the Web Parts control that is being added and the zone it is being added to.

Constructors

WebPartAddingEventArgs(WebPart, WebPartZoneBase, Int32)

Initializes a new instance of the WebPartAddingEventArgs class.

Properties

Cancel

Gets or sets a value indicating whether the event should be canceled.

(Inherited from CancelEventArgs)
WebPart

Gets the Web Parts control involved in the cancelable event.

(Inherited from WebPartCancelEventArgs)
Zone

Gets or sets the Web Parts zone that the Web Parts control is being added to.

ZoneIndex

Gets or sets the index position of a WebPart control within its zone.

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to