CMSWebPartZone Class

Web part zone control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.ExtendedControls.CMSWebControl
        CMS.PortalControls.CMSWebPartZone

Namespace: CMS.PortalControls
Assembly: CMS.PortalControls (in CMS.PortalControls.dll) Version: 8.2.23

Syntax

public class CMSWebPartZone : CMSWebControl, 
	ICMSVariantsControl, ICMSPortalControl, INamingContainer, ITimeZoneManager

The CMSWebPartZone type exposes the following members.

Constructors

	Name	Description
Public method	CMSWebPartZone()	Constructor.
Public method	CMSWebPartZone(Boolean)	Constructor.

Methods

	Name	Description
Public method	cachedControl_PreRender	PreRender event handler.
Public method	ClearCache	Clears the caches of all the web parts.
Public method Static member	EnablePartialCache	Returns true if the partial caching is enabled.
Public method	FindWebPart(String)	Finds the web part with specific name.
Public method	FindWebPart(Type)	Finds the web part with specific type (first web part).
Public method	GetImageUrl	Gets UI image relative path.
Public method	GetSpellCheckFields	Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
Public method	GetValue	Returns the value of the given webpart property property.
Public method	GetWebPart	Returns web part with the specified name or null if not found.
Public method Static member	GetWebPartUrl	Gets the URL for the web part to load.
Protected method	LoadCachedWebPart	Loads the content to the partially cached web part
Public method	LoadRegionsContent	Loads the editable regions content.
Public method Static member	LoadWebPart	Loads the web part to the given zone. Returns the newly created web part.
Public method	LoadWebParts	Loads the web parts to the control.
Public method	LoadWebPartsContent	Loads the web parts content.
Public method	OnContentLoaded	Method that is called when the page content is fully loaded.
Protected method	OnInit	Init action. (Overrides CMSWebControl.OnInit(EventArgs).)
Protected method	OnLoad	Load action. (Overrides Control.OnLoad(EventArgs).)
Protected method	OnPreRender	PreRender action. (Overrides Control.OnPreRender(EventArgs).)
Protected method	ReloadControls	Obsolete. Reloads the zone controls.
Public method	ReloadData	Causes reloading the data, override to implement the data reloading procedure.
Public method	RemoveVariantFromCache	Removes the variant from cache.
Protected method	Render	Render action. (Overrides WebControl.Render(HtmlTextWriter).)
Public method	RequiresWebPartManagement	Obsolete. Returns true if the web part management support is required.
Public method	ResolveMacros	Resolves the macros within current WebPart context.
Public method	SaveContent	Saves the page content to the page info.
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value.
Public method	Validate	Saves the page content to the page info.

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	extDragDrop	Drag and drop extender.
Protected field	lblTitle	Zone title.
Protected field	mCMSEditableControls	List of the editable controls located under current placeholder.
Protected field	mContainer	Container info object.
Protected field	mContextResolver	Zone context resolver.
Protected field	mLocalProperties	Local web part properties.
Protected field	mNotResolveProperties	List of the property names that should not be resolved with macros.
Protected field	mOrphaned	True if the zone is orphaned - Not included in layout.
Protected field	mPagePlaceholder	Parent page placeholder.
Protected field	mParentZoneControl	If this instance is a zone variant then this variable contains the parent zone control (CMSWebPartZone), otherwise is null.
Protected field	mPnlZoneVariants	Container for zone variants.
Protected field	mShortClientID	Short client ID.
Protected field	mSQLProperties	List of the property names that are used in SQL queries and should avoid SQL injection.
Protected field	mUpdatePanel	Update panel.
Protected field	mViewMode	Zone view mode.
Protected field	mWebPartContainer	Web part container.
Protected field	mWebParts	Collection of all the web part located within the zone.
Protected field	mWidgetZoneType	Zone type.
Protected field	mZoneInstance	Zone instance with the settings.
Protected field	pnlCue	Drop cue panel.
Protected field	pnlDesignHeader	Zone design mode header container.
Protected field	pnlZone	Zone container.

Properties

	Name	Description
Public property	AdjustFreeLayoutToParent	If true, then the size of the free layout is adjusted to match the parent size
Public property	Align	Align
Public property	AllowModifyWebPartCollection	If true, the zone allows adding new web parts
Public property	CMSEditableControls	Returns the array of the editable controls.
Public property	ConditionalLayout	Conditional layout within which the zone is placed.
Public property	Container	Web part container object.
Public property	ContainerAfter	Container to render after the control.
Public property	ContainerBefore	Container to render before the control.
Public property	ContainerClientID	Returns the client ID of the zone container control
Public property	ContainerHideOnCurrentPage	Returns true if the container should be hidden on current page (hide container on subpages in effect).
Public property	ContainerHideOnSubPages	Hide container on sub pages.
Public property	ContainerName	Container name.
Public property	ContainerTitle	Container title.
Public property	ContentAfter	Content after.
Public property	ContentBefore	Content before.
Public property	ContextResolver	Web part zone context resolver.
Public property	CustomTimeZone	Returns custom time zone info.
Public property	DisplayHeader	If true, the web part zone displays header in design mode
Public property	DisplayToRoles	Display to roles.
Public property	HasVariants	Indicates whether the zone has any variants.
Public property	HeaderContainer	Control to which the zone header should be rendered
Public property	HideOnCurrentPage	Returns true if the control should be hidden on current page (hide control on subpages in effect).
Public property	HideOnSubPages	Hide on sub pages.
Public property	ChildrenHaveVariants	Returns true if the children components have any variants
Public property	ID	Gets or sets the programmatic identifier assigned to the server control. (Overrides Control.ID.)
Public property	InstanceGUID	Web part instance GUID.
Public property	IsEmpty	Returns true if the zone is empty (no web part is visible)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	IsVariant	Indicates whether this web part is a variant of an existing zone.
Public property	IsVisible	Returns true if the web part zone is visible.
Public property	LayoutType	Zone layout type
Public property	LayoutZone	True if the zone is generated by web part layout.
Public property	Margin	Margin
Public property	NotResolveProperties	List of the property names that should not be resolved with macros.
Public property	Padding	Padding
Public property	PagePlaceholder	Parent page placeholder.
Public property	ParentHasVariants	Returns true if the parent component has any variants
Public property	ParentWebPart	Parent portal component
Public property	ParentZoneControl	Gets the parent zone control (CMSWebPartZone) if this instance is a zone variant. Otherwise returns null.
Protected property	PnlZoneVariants	Container for zone variants.
Public property	PortalManager	Parent portal manager.
Public property	ShortClientID	Returns the short client ID of the web part.
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	ShowForDocumentTypes	Show for document types.
Public property	SimpleRender	If true, the zone is rendered in a simple mode
Public property	SQLProperties	List of the property names that are used in SQL queries and should avoid SQL injection.
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Overrides WebControl.TagKey.)
Public property	TimeZoneType	Returns time zone type.
Public property	TitleLabel	Gets the zone title label.
Public property	UIContext	Returns control's UI context (Inherited from CMSWebControl.)
Public property	UpdatePanel	Update panel of the web part.
Public property	UseUpdatePanel	Use update panel.
Public property	ViewMode	Page mode of the current zone.
Public property	WebPartContainer	Web part container control.
Public property	WebPartManagementRequired	Indicates whether the web part management support is required.
Public property	WebParts	List of WebParts contained within the zone.
Public property	WidgetZoneType	Widget zone type.
Public property	Wireframe	If set to true, the zone is set to free layout adjusting to parent and simple rendering mode for wireframe purposes
Public property	ZoneHeight	Height of the web part zone
Public property	ZoneId	Zone Id used mainly in conditional layouts where zone should be shared in multiple layouts.
Public property	ZoneInstance	Web part zone instance object.
Public property	ZoneTitle	Zone title.
Public property	ZoneType	Gets or sets the type of the zone. This value is processed only in the UI pages.
Public property	ZoneWidth	Width of the web part zone