WebPartDisplayMode.AssociatedWithToolZone Property

Definition

Gets a value that indicates whether a certain display mode is associated with a class that derives from the ToolZone class.

public:
 virtual property bool AssociatedWithToolZone { bool get(); };
public virtual bool AssociatedWithToolZone { get; }
member this.AssociatedWithToolZone : bool
Public Overridable ReadOnly Property AssociatedWithToolZone As Boolean

Property Value

true if the display mode is associated with a ToolZone class; otherwise, false. The default is false.

Remarks

When a Web Parts page enters a display mode whose AssociatedWithToolZone property is set to true, the WebPartManager control interprets that to mean that an associated class derives from the ToolZone class, and that additional user interface (UI) elements need to be displayed. For example, when a page enters edit mode, special zones that contain UI elements for editing Web Parts controls appear on the page. This behavior is made possible because the AssociatedWithToolZone property value on the EditDisplayMode field is set to true.

Notes to Inheritors

Classes that derive from the WebPartDisplayMode base class to create custom display modes must override the AssociatedWithToolZone property in order to set its value.

Applies to

See also