Click or drag to resize
CMSWebPartZone Class
Web part zone control.
Inheritance Hierarchy

Namespace: CMS.PortalControls
Assembly: CMS.PortalControls (in CMS.PortalControls.dll) Version: 9.0.0
public class CMSWebPartZone : CMSWebControl, 
	ICMSVariantsControl, ICMSPortalControl, INamingContainer, ITimeZoneManager

The CMSWebPartZone type exposes the following members.

Protected fieldextDragDrop
Drag and drop extender.
Protected fieldlblTitle
Zone title.
Protected fieldmCMSEditableControls
List of the editable controls located under current placeholder.
Protected fieldmContainer
Container info object.
Protected fieldmContextResolver
Zone context resolver.
Protected fieldmLocalProperties
Local web part properties.
Protected fieldmNotResolveProperties
List of the property names that should not be resolved with macros.
Protected fieldmOrphaned
True if the zone is orphaned - Not included in layout.
Protected fieldmPagePlaceholder
Parent page placeholder.
Protected fieldmParentZoneControl
If this instance is a zone variant then this variable contains the parent zone control (CMSWebPartZone), otherwise is null.
Protected fieldmPnlZoneVariants
Container for zone variants.
Protected fieldmShortClientID
Short client ID.
Protected fieldmSQLProperties
List of the property names that are used in SQL queries and should avoid SQL injection.
Protected fieldmUpdatePanel
Update panel.
Protected fieldmViewMode
Zone view mode.
Protected fieldmWebPartContainer
Web part container.
Protected fieldmWebParts
Collection of all the web part located within the zone.
Protected fieldmWidgetZoneType
Zone type.
Protected fieldmZoneInstance
Zone instance with the settings.
Protected fieldpnlCue
Drop cue panel.
Protected fieldpnlDesignHeader
Zone design mode header container.
Protected fieldpnlZone
Zone container.
Public propertyAdjustFreeLayoutToParent
If true, then the size of the free layout is adjusted to match the parent size
Public propertyAlign
Public propertyAllowModifyWebPartCollection
If true, the zone allows adding new web parts
Public propertyCMSEditableControls
Returns the array of the editable controls.
Public propertyConditionalLayout
Conditional layout within which the zone is placed.
Public propertyContainer
Web part container object.
Public propertyContainerAfter
Container to render after the control.
Public propertyContainerBefore
Container to render before the control.
Public propertyContainerClientID
Returns the client ID of the zone container control
Public propertyContainerHideOnCurrentPage
Returns true if the container should be hidden on current page (hide container on subpages in effect).
Public propertyContainerHideOnSubPages
Hide container on sub pages.
Public propertyContainerName
Container name.
Public propertyContainerTitle
Container title.
Public propertyContentAfter
Content after.
Public propertyContentBefore
Content before.
Public propertyContextResolver
Web part zone context resolver.
Public propertyCustomTimeZone
Returns custom time zone info.
Public propertyDisplayToRoles
Display to roles.
Public propertyHasVariants
Indicates whether the zone has any variants.
Public propertyHeaderContainer
Control to which the zone header should be rendered
Public propertyHideOnCurrentPage
Returns true if the control should be hidden on current page (hide control on subpages in effect).
Public propertyHideOnSubPages
Hide on sub pages.
Public propertyChildrenHaveVariants
Returns true if the children components have any variants
Public propertyID
Gets or sets the programmatic identifier assigned to the server control.
(Overrides ControlID.)
Public propertyInstanceGUID
Web part instance GUID.
Public propertyIsEmpty
Returns true if the zone is empty (no web part is visible)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyIsVariant
Indicates whether this web part is a variant of an existing zone.
Public propertyIsVisible
Returns true if the web part zone is visible.
Public propertyLayoutType
Zone layout type
Public propertyLayoutZone
True if the zone is generated by web part layout.
Public propertyMargin
Public propertyNotResolveProperties
List of the property names that should not be resolved with macros.
Public propertyPadding
Public propertyPagePlaceholder
Parent page placeholder.
Public propertyParentHasVariants
Returns true if the parent component has any variants
Public propertyParentWebPart
Parent portal component
Public propertyParentZoneControl
Gets the parent zone control (CMSWebPartZone) if this instance is a zone variant. Otherwise returns null.
Protected propertyPnlZoneVariants
Container for zone variants.
Public propertyPortalManager
Parent portal manager.
Public propertyShortClientID
Returns the short client ID of the web part.
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertyShowForDocumentTypes
Show for document types.
Public propertySQLProperties
List of the property names that are used in SQL queries and should avoid SQL injection.
Protected propertyTagKey
Overrides the generation of the SPAN tag with custom tag.
(Overrides WebControlTagKey.)
Public propertyTimeZoneType
Returns time zone type.
Public propertyTitleLabel
Gets the zone title label.
Public propertyUIContext
Returns control's UI context
(Inherited from CMSWebControl.)
Public propertyUpdatePanel
Update panel of the web part.
Public propertyUseUpdatePanel
Use update panel.
Public propertyViewMode
Page mode of the current zone.
Public propertyWebPartContainer
Web part container control.
Public propertyWebPartManagementRequired
Indicates whether the web part management support is required.
Public propertyWebParts
List of WebParts contained within the zone.
Public propertyWidgetZoneType
Widget zone type.
Public propertyZoneHeight
Height of the web part zone
Public propertyZoneId
Zone Id used mainly in conditional layouts where zone should be shared in multiple layouts.
Public propertyZoneInstance
Web part zone instance object.
Public propertyZoneTitle
Zone title.
Public propertyZoneType
Gets or sets the type of the zone. This value is processed only in the UI pages.
Public propertyZoneWidth
Width of the web part zone
Public methodcachedControl_PreRender
PreRender event handler.
Public methodClearCache
Clears the caches of all the web parts.
Public methodStatic memberEnablePartialCache
Returns true if the partial caching is enabled.
Public methodFindWebPart(String)
Finds the web part with specific name.
Public methodFindWebPart(Type)
Finds the web part with specific type (first web part).
Public methodGetImageUrl
Gets UI image relative path.
Public methodGetSpellCheckFields
Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
Public methodGetValue
Returns the value of the given webpart property property.
Public methodGetWebPart
Returns web part with the specified name or null if not found.
Public methodStatic memberGetWebPartUrl
Gets the URL for the web part to load.
Protected methodLoadCachedWebPart
Loads the content to the partially cached web part
Public methodLoadRegionsContent
Loads the editable regions content.
Public methodStatic memberLoadWebPart
Loads the web part to the given zone. Returns the newly created web part.
Public methodLoadWebParts
Loads the web parts to the control.
Public methodLoadWebPartsContent
Loads the web parts content.
Public methodOnContentLoaded
Method that is called when the page content is fully loaded.
Protected methodOnInit
Init action.
(Overrides CMSWebControlOnInit(EventArgs).)
Protected methodOnLoad
Load action.
(Overrides ControlOnLoad(EventArgs).)
Protected methodOnPreRender
PreRender action.
(Overrides ControlOnPreRender(EventArgs).)
Public methodReloadData
Causes reloading the data, override to implement the data reloading procedure.
Public methodRemoveVariantFromCache
Removes the variant from cache.
Protected methodRender
Render action.
(Overrides WebControlRender(HtmlTextWriter).)
Public methodResolveMacros
Resolves the macros within current WebPart context.
Public methodSaveContent
Saves the page content to the page info.
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
Public methodValidate
Saves the page content to the page info.
Extension Methods
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodCallHandled
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 MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
See Also