UILayout Class

.NET representation of the UI Layout JavaScript plug-in

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.Base.Web.UI.CMSWebControl
        CMS.UIControls.UILayout
          CMS.UIControls.UIElementLayout

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 10.0.0

Syntax

public class UILayout : CMSWebControl, INamingContainer

The UILayout type exposes the following members.

Constructors

	Name	Description
Public method	UILayout

Fields

	Name	Description
Protected field	mStopProcessing	Indicates if processing of the placeholder should be stopped.

Properties

	Name	Description
Public property	ApplyDemoStyles	When enabled, the layout will apply basic styles directly to resizers and buttons.
Public property	Closable	Can a pane be closed?
Public property	ContainerSelector	Element the layout is created under. Most commonly 'body' element (default value). Can be any block-element.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	LoadOn	Defines when the UI Layout JavaScript plug-in should be initialized. Sometimes it can be useful to register the layout script after document is ready or window is loaded.
Public property	OnCloseEndScript	Script or function name called after 'close' is done.
Public property	OnCloseStartScript	Script or function name called before 'close' is done.
Public property	OnHideEndScript	Script or function name called after 'hide' is done.
Public property	OnHideStartScript	Script or function name called before 'hide' is done.
Public property	OnOpenEndScript	Script or function name called after 'open' is done.
Public property	OnOpenStartScript	Script or function name called before 'open' is done.
Public property	OnResizeEndScript	Script or function name called after 'resize' is done.
Public property	OnResizeStartScript	Script or function name called before 'resize' is done.
Public property	OnShowEndScript	Script or function name called after 'show' is done.
Public property	OnShowStartScript	Script or function name called before 'show' is done.
Public property	Panes	Collection of panes. Cannot contain more than one pane for one direction (NESW or center).
Public property	Resizable	When open, can a pane be resized?
Public property	ScrollToBookmarkOnLoad	This option handles of bookmarks that are passed on the URL of the page.
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	Slidable	When closed, can a pane 'slide open' over adjacent panes?
Public property	StopProcessing	Indicates if processing of the UI panel should be stopped.

Methods

	Name	Description
Protected method	OnInit	Init event handler (Overrides CMSWebControl.OnInit(EventArgs).)
Protected method	OnPreRender	PreRender event handler (Overrides Control.OnPreRender(EventArgs).)

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