Edit

Share via


ToolZone Constructors

Definition

Associates one or more WebPartDisplayMode objects with a particular type of ToolZone zone, enabling that zone to be displayed when a page is in the appropriate page display mode.

Overloads

ToolZone(ICollection)

Associates a collection of WebPartDisplayMode objects with a particular ToolZone zone, so that the zone can be displayed in the appropriate page display modes.

ToolZone(WebPartDisplayMode)

Associates a single WebPartDisplayMode object with a particular ToolZone zone, so that the zone can be displayed in the appropriate page display mode.

ToolZone(ICollection)

Associates a collection of WebPartDisplayMode objects with a particular ToolZone zone, so that the zone can be displayed in the appropriate page display modes.

protected:
 ToolZone(System::Collections::ICollection ^ associatedDisplayModes);
protected ToolZone (System.Collections.ICollection associatedDisplayModes);
new System.Web.UI.WebControls.WebParts.ToolZone : System.Collections.ICollection -> System.Web.UI.WebControls.WebParts.ToolZone
Protected Sub New (associatedDisplayModes As ICollection)

Parameters

associatedDisplayModes
ICollection

An ICollection of WebPartDisplayMode objects that determine when a zone can be displayed.

Exceptions

The associatedDisplayModes parameter is equal to null or 0.

Remarks

The ToolZone constructor is used to associate a ToolZone zone with one or more display modes. This enables the tool zone to be displayed in the associated display modes.

Note

In the implementation of ToolZone zones provided by the Web Parts control set, each zone is associated with only one display mode. However, using this overload of the constructor, it is possible to associate a custom zone with multiple display modes.

See also

Applies to

ToolZone(WebPartDisplayMode)

Associates a single WebPartDisplayMode object with a particular ToolZone zone, so that the zone can be displayed in the appropriate page display mode.

protected:
 ToolZone(System::Web::UI::WebControls::WebParts::WebPartDisplayMode ^ associatedDisplayMode);
protected ToolZone (System.Web.UI.WebControls.WebParts.WebPartDisplayMode associatedDisplayMode);
new System.Web.UI.WebControls.WebParts.ToolZone : System.Web.UI.WebControls.WebParts.WebPartDisplayMode -> System.Web.UI.WebControls.WebParts.ToolZone
Protected Sub New (associatedDisplayMode As WebPartDisplayMode)

Parameters

associatedDisplayMode
WebPartDisplayMode

A WebPartDisplayMode that determines when a zone can be displayed.

Exceptions

The associatedDisplayMode parameter is equal to null.

Remarks

The ToolZone constructor is used to associate a ToolZone zone with a single display mode. This enables the tool zone to be displayed when a page enters that display mode. For example, a CatalogZone control can be displayed only in CatalogDisplayMode mode.

See also

Applies to