CMSPagePlaceholder Class

Page content container.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.PlaceHolder
      CMS.Base.Web.UI.CMSPlaceHolder
        CMS.PortalEngine.Web.UI.CMSPagePlaceholder

Namespace: CMS.PortalEngine.Web.UI
Assembly: CMS.PortalEngine.Web.UI (in CMS.PortalEngine.Web.UI.dll) Version: 10.0.0

Syntax

public class CMSPagePlaceholder : CMSPlaceHolder, 
	ICMSPortalControl, INamingContainer, IPageManager

The CMSPagePlaceholder type exposes the following members.

Constructors

	Name	Description
Public method	CMSPagePlaceholder()	Constructor.
Public method	CMSPagePlaceholder(CMSPortalManager)	Constructor, initializes the parent portal manager.

Fields

	Name	Description
Protected field	lblTitle	Control title.
Protected field	mAllowDesignModeActions	If true, placeholder allows the design mode actions.
Protected field	mCMSEditableControls	ArrayList of the editable controls located under current placeholder.
Protected field	mDesignEnabled	If true, placeholder is enabled in design mode.
Protected field	mChildPagePlaceholders	Child page placeholders.
Protected field	mIsAuthorized	Indicates whether user is authorized to read the content when in live site mode.
Protected field	mLayoutInfo	Placeholder level layout info.
Protected field	mNoLayoutPlaceholder	Placeholder to supply window to the next page level when layout not defined.
Protected field	mPageLayout	Parent page layout.
Protected field	mPageLevel	Page level of the Placeholder.
Protected field	mPagePlaceholder	Parent page placeholder.
Protected field	mPageTemplateInfo	Placeholder level page template layout info.
Protected field	mPortalManager	Parent portal manager.
Protected field	mSiblingPagePlaceholders	Sibling page placeholders.
Protected field	mViewMode	If set, the placeholder has overridden ViewMode.
Protected field	pnlDesignContent	Design mode content container.
Protected field	pnlDesignHeader	Design mode header container.
Protected field	pnlPlaceholder	Overall container.

Properties

	Name	Description
Public property	AllowDesignModeActions	If true, placeholder allows the design mode actions.
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public property	CMSEditableControls	Returns the array of the editable controls.
Public property	CssClass	CSS class for the envelope
Public property	DesignEnabled	If true, placeholder is enabled in design mode.
Public property	DisplayHeader	If true, the page placeholder displays header in design mode
Public property	HasExternalContent	If true, placeholder is using external content (does not load the layout if available and uses the page info if set).
Public property	HidePageTemplateName	If true, the placeholder hides the page template name
Public property	CheckPermissions	If true, placeholder checks access permissions for the editable web parts content.
Public property	ChildPagePlaceholders	Returns the table of all the inner placeholders.
Public property	IsAuthorized	Returns true if the user is authorized for the document.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSPlaceHolder.)
Public property	Layout	Returns the layout control.
Public property	LayoutInfo	Returns the layout information.
Public property	LayoutTemplate	Layout template, if set, the given layout is used.
Public property	PageInfo	Page info.
Public property	PageLevel	Page level.
Public property	PagePlaceholder	Parent page placeholder.
Public property	PagePlaceholderID	Page placeholder ID
Public property	PageTemplateInfo	Returns the page template information.
Public property	PortalManager	Parent portal manager.
Public property	Root	If true, the placeholder is the main (root) placeholder on the page.
Public property	ShortID	Short ID of the control. (Inherited from CMSPlaceHolder.)
Public property	SiblingPagePlaceholders	Returns the table of all the sibling page placeholders (page placeholders on the same level).
Public property	SiteName	Site code name.
Public property	TemplateInstance	Returns page template instance structure.
Public property	UsingDefaultDocument	If true, placeholder is using default document.
Public property	UsingDefaultPage	Indicates whether the placeholder is using either default document or default page template.
Public property	UsingDefaultPageTemplate	If true, placeholder is using default page template.
Public property	ViewMode	Page mode of the current placeholder page.
Public property	WebPartZones	Web part zones collection.

Methods

	Name	Description
Public method	Append(String[])	Appends the given content to the placeholder (Inherited from CMSPlaceHolder.)
Public method	Append(Control)	Appends the given control to the placeholder (Inherited from CMSPlaceHolder.)
Public method	Clear	Clears the placeholder content (Inherited from CMSPlaceHolder.)
Public method	ClearCache	Clears the cache of the placeholder.
Protected method	CreateChildControls	Initializes the child controls. (Overrides Control.CreateChildControls().)
Public method	FindAllWebParts	Finds all web parts of specified type.
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	FindZone	Finds the zone by its ID.
Protected method	FinishCurrent	Appends the given content to the placeholder (Inherited from CMSPlaceHolder.)
Public method	GetImageUrl	Gets UI image relative path.
Public method	GetSpellCheckFields	Returns the array list of the field IDs (Client IDs of the inner controls) that should be spell checked.
Public method	LoadContent	Load the page content to the placeholder.
Public method	LoadLayout	Loads the given layout.
Public method	LoadOrphanedZones	Loads the orphaned zones to the.
Public method	LoadRegionsContent	Loads the editable regions content.
Public method	LoadTextLayout	Loads the given text layout.
Protected method	LoadViewState	Load ViewState event handler. (Overrides Control.LoadViewState(Object).)
Protected method	OnDataBinding	Databinding event. (Overrides Control.OnDataBinding(EventArgs).)
Protected method	OnInit	Init event handler (Overrides CMSPlaceHolder.OnInit(EventArgs).)
Protected method	OnLoad	Load event handler. (Overrides Control.OnLoad(EventArgs).)
Protected method	OnPreRender	PreRender event handler (Inherited from CMSPlaceHolder.)
Public method Static member	RegisterEditLayoutScript	Registers edit layout script for specified control
Public method	ReloadControls	Reload the page controls.
Public method	ReloadData	Causes reloading the data, override to implement the data reloading procedure.
Protected method	Render	Renders the control. (Overrides Control.Render(HtmlTextWriter).)
Public method	RequiresWebPartManagement	Returns true if the web part management support is required.
Public method	SaveContent	Saves the page content to the page info.
Public method	Validate	Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.

Extension Methods

	Name	Description
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	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)