Click or drag to resize
UILayout Class
.NET representation of the UI Layout JavaScript plug-in
Inheritance Hierarchy

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23
Syntax
C#
public class UILayout : CMSWebControl, INamingContainer

The UILayout type exposes the following members.

Constructors
  NameDescription
Public methodUILayout
Top
Methods
Extension Methods
  NameDescription
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 MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
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 MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
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 CoreExtensions.)
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.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Protected fieldmStopProcessing
Indicates if processing of the placeholder should be stopped.
Top
Properties
  NameDescription
Public propertyApplyDemoStyles
When enabled, the layout will apply basic styles directly to resizers and buttons.
Public propertyClosable
Can a pane be closed?
Public propertyContainerSelector
Element the layout is created under. Most commonly 'body' element (default value). Can be any block-element.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyLoadOn
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 propertyOnCloseEndScript
Script or function name called after 'close' is done.
Public propertyOnCloseStartScript
Script or function name called before 'close' is done.
Public propertyOnHideEndScript
Script or function name called after 'hide' is done.
Public propertyOnHideStartScript
Script or function name called before 'hide' is done.
Public propertyOnOpenEndScript
Script or function name called after 'open' is done.
Public propertyOnOpenStartScript
Script or function name called before 'open' is done.
Public propertyOnResizeEndScript
Script or function name called after 'resize' is done.
Public propertyOnResizeStartScript
Script or function name called before 'resize' is done.
Public propertyOnShowEndScript
Script or function name called after 'show' is done.
Public propertyOnShowStartScript
Script or function name called before 'show' is done.
Public propertyPanes
Collection of panes. Cannot contain more than one pane for one direction (NESW or center).
Public propertyResizable
When open, can a pane be resized?
Public propertyScrollToBookmarkOnLoad
This option handles of bookmarks that are passed on the URL of the page.
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertySlidable
When closed, can a pane 'slide open' over adjacent panes?
Public propertyStopProcessing
Indicates if processing of the UI panel should be stopped.
Public propertyUIContext
Returns control's UI context
(Inherited from CMSWebControl.)
Top
See Also