Click or drag to resize
CMSAbstractLayout Class
Abstract page layout class.
Inheritance Hierarchy

Namespace: CMS.PortalControls
Assembly: CMS.PortalControls (in CMS.PortalControls.dll) Version: 9.0.0
Syntax
C#
public abstract class CMSAbstractLayout : AbstractUserControl, 
	ICMSPortalControl

The CMSAbstractLayout type exposes the following members.

Constructors
  NameDescription
Protected methodCMSAbstractLayout
Top
Fields
  NameDescription
Protected fieldmConditionalLayouts
List of conditional layout controls hosted by this layout
Protected fieldmContents
List of the content placeholders.
Protected fieldmPageInfo
Page info for current layout.
Protected fieldmPagePlaceholder
Parent page placeholder.
Protected fieldmTemplateInstance
Page template instance.
Protected fieldmWebPartsContentLoaded
True if the web part content was already loaded
Protected fieldmWebPartZones
Collection of all the layout web part zones.
Protected fieldmWebPartZonesList
Web part zones list.
Top
Properties
  NameDescription
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyConditionalLayouts
Returns the list of found conditional layouts
Public propertyContents
Returns the list of found content placeholders.
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from AbstractUserControl.)
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyPageInfo
Page info.
Public propertyPagePlaceholder
Parent page placeholder.
Public propertyPortalManager
Portal manager for the page.
Public propertyCode exampleResourcePrefix
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertyTemplateInstance
Returns page template instance structure.
Public propertyUIContext
Control's UI Context
(Inherited from AbstractUserControl.)
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Public propertyWebPartZones
Returns the table of all the inner web part zones.
Public propertyWebPartZonesList
Returns the list of all the inner web part zones (CMSWebPartZone controls).
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodClearCache
Clears the cache of all the web part zones.
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Protected methodEnsureZones
Ensures the lists of zones.
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodFindAllWebParts
Finds all web parts of specified type.
Public methodFindWebPart(String)
Finds the web part with specific name.
Public methodFindWebPart(Type)
Finds the web part with specific type (first web part).
Public methodFindZone
Finds the zone by its ID.
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetSpellCheckFields
Returns the arraylist of the field IDs (Client IDs of the inner controls) that should be spell checked.
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Public methodCheckLayoutsVisibility
Checks the visibility of all conditional layouts
Public methodLoadContent
Loads the page content to the layout.
Public methodLoadOrphanedZones
Loads the orphaned zones to the layout.
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLoadWebPartsContent
Loads the content of the underlying web parts
Public methodLoadZone
Loads the given web part zone.
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodOnContentLoaded
Method that is called when the page content is fully loaded.
Protected methodOnInit
Init event handler.
(Inherited from AbstractUserControl.)
Protected methodOnLoad
Load event handler.
(Inherited from AbstractUserControl.)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Public methodRegisterZone
Registers the zone within the list of zones.
Public methodReloadData
Causes reloading the data, override to implement the data reloading procedure.
Public methodRelocateContent
Relocates the layout content to the correct locations.
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodRequiresWebPartManagement
Returns true if the web part management support is required.
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSaveContent
Saves the page content to current page info.
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodValidate
Saves the page content to current page info.
Top
Extension Methods
  NameDescription
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 MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
See Also