CMSAbstractLayout Class

Abstract page layout class.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.ExtendedControls.AbstractUserControl
          CMS.PortalControls.CMSAbstractLayout

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

Syntax

public abstract class CMSAbstractLayout : AbstractUserControl, 
	ICMSPortalControl

The CMSAbstractLayout type exposes the following members.

Constructors

	Name	Description
Protected method	CMSAbstractLayout

Fields

	Name	Description
Protected field	mConditionalLayouts	List of conditional layout controls hosted by this layout
Protected field	mContents	List of the content placeholders.
Protected field	mPageInfo	Page info for current layout.
Protected field	mPagePlaceholder	Parent page placeholder.
Protected field	mTemplateInstance	Page template instance.
Protected field	mWebPartsContentLoaded	True if the web part content was already loaded
Protected field	mWebPartZones	Collection of all the layout web part zones.
Protected field	mWebPartZonesList	Web part zones list.

Properties

	Name	Description
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	ConditionalLayouts	Returns the list of found conditional layouts
Public property	Contents	Returns the list of found content placeholders.
Public property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditedObject	Control's edited object (Inherited from AbstractUserControl.)
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	PageInfo	Page info.
Public property	PagePlaceholder	Parent page placeholder.
Public property	PortalManager	Portal manager for the page.
Public property Code example	ResourcePrefix	Prefix for the resource strings which are used for the localization by the control and its child controls. (Inherited from AbstractUserControl.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	TemplateInstance	Returns page template instance structure.
Public property	UIContext	Control's UI Context (Inherited from AbstractUserControl.)
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Public property	WebPartZones	Returns the table of all the inner web part zones.
Public property	WebPartZonesList	Returns the list of all the inner web part zones (CMSWebPartZone controls).

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractUserControl.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddMessage	Adds message text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	ClearCache	Clears the cache of all the web part zones.
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Protected method	EnsureZones	Ensures the lists of zones.
Public method	Eval(String)	Evaluates the given value (Inherited from AbstractUserControl.)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractUserControl.)
Public method	EvalBool	Evaluates the item data and converts it to the bool. (Inherited from AbstractUserControl.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from AbstractUserControl.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from AbstractUserControl.)
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute. (Inherited from AbstractUserControl.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from AbstractUserControl.)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	EvalText(String, Boolean)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
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.
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetSpellCheckFields	Returns the arraylist of the field IDs (Client IDs of the inner controls) that should be spell checked.
Public method	GetString	Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined. (Inherited from AbstractUserControl.)
Public method	CheckLayoutsVisibility	Checks the visibility of all conditional layouts
Public method	LoadContent	Loads the page content to the layout.
Public method	LoadOrphanedZones	Loads the orphaned zones to the layout.
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	LoadWebPartsContent	Loads the content of the underlying web parts
Public method	LoadZone	Loads the given web part zone.
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Public method	OnContentLoaded	Method that is called when the page content is fully loaded.
Protected method	OnInit	Init event handler. (Inherited from AbstractUserControl.)
Protected method	OnLoad	Load event handler. (Inherited from AbstractUserControl.)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Public method	RegisterZone	Registers the zone within the list of zones.
Public method	ReloadData	Causes reloading the data, override to implement the data reloading procedure.
Public method	RelocateContent	Relocates the layout content to the correct locations.
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
Public method	RequiresWebPartManagement	Returns true if the web part management support is required.
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	SaveContent	Saves the page content to current page info.
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowMessage(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	Validate	Saves the page content to current page info.

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.)