Click or drag to resize
UILayoutPane Class
Part of UI layout (can be center or one of cardinal directions).
Inheritance Hierarchy

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 12.0.0
Syntax
C#
public class UILayoutPane : CMSUserControl

The UILayoutPane type exposes the following members.

Constructors
  NameDescription
Public methodUILayoutPane
Top
Fields
  NameDescription
Public fieldStatic memberPANE_AUTO_SIZE
Constant for automatic size of a pane.
Top
Properties
  NameDescription
Public propertyAppendSrc
Indicates whether append Src to layout pane. Used in situations when URL is set by another control.
Public propertyApplyDemoStyles
When enabled, the layout will apply basic styles directly to resizers & buttons.
Public propertyButtonClass
Prefix used for auto-generated classNames for each custom buttons.
Public propertyCheckPhysicalFile
Indicates whether existence of ascx file should be checked
Public propertyClosable
Can a pane be closed?
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyContainer
Container to instantiate the template in.
Public propertyContentIgnoreSelector
Selector string for INNER divs/elements. These elements will be 'ignored' when calculations are done to auto-size the content element. This may be necessary if there are elements inside the pane that are absolutely-positioned and intended to 'overlay' other elements.
Public propertyContentSelector
Selector string for INNER div/element. This div will auto-size so only it scrolls, and not the entire pane.
Public propertyControlContext
Control context.
(Inherited from CMSUserControl.)
Public propertyControlID
Control ID
Public propertyControlPath
Allows to get or set a relative path to custom control (e.g. ~/Controls/Control.ascx). This control will be displayed instead of UILayoutPane's template. (It has higher priority.)
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentResolver
Control's resolver
(Inherited from CMSUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDirection
Direction (location) of the pane.
Public propertyDisplayMode
Gets or sets display mode of the control.
(Inherited from CMSUserControl.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from CMSUserControl.)
Public propertyElementName
Code name of the UIElement.
Public propertyFrameBorder
Indicates whether frame border should be rendered
Public propertyFxName
Animation effect for open/close. Choose a preset effect OR can specify a custom fxName as long as you also specify fxSettings (even if fxSettings is just empty - {}).
Public propertyFxSettings
If a non-standard effect is specified, then fxSettings is REQUIRED (can be empty though).
Public propertyFxSpeed
Speed of animations – standard jQuery keyword like 'fast', or a millisecond value.
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyInitClosed
Indicates if the pane is 'closed' when layout is created
Public propertyIsCMSDesk
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyLiveContentResizing
True = re-measure header/footer heights as resizer is dragged.
Public propertyLivePaneResizing
LIVE Resizing as resizer is dragged.
Public propertyMaskContents
When enabled, layout will 'mask' iframes on the page when the resizer-bar is 'dragged' to resize a pane. This solved problems related to dragging an element over an iframe.
Public propertyMaxSize
Maximum-size limit when resizing a pane (0 = as large as pane can go).
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyMinSize
Minimum-size limit when resizing a pane (0 = as small as pane can go).
Public propertyModuleAvailabilityForSiteRequired
Indicates if site availability of the corresponding module (module with name in format "cms.[ElementName]") is required for each UI element in the menu. Takes effect only when corresponding module exists.
Public propertyModuleName
Code name of the module.
Public propertyNoFrames
String that is rendered only along with iframe.
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 propertyPaneClass
Prefix used for stylesheet classes related to this pane.
Public propertyParameter
Control parameter.
(Inherited from InlineUserControl.)
Protected propertyProperties
Control properties.
(Inherited from InlineUserControl.)
Public propertyQueryParameterName
Name of URL query parameter that is used for tab preselection.
Public propertyRenderAs
HTML tag representing the pane. Use block elements or iframe.
Public propertyRenderPane
If true, the pane is rendered
Public propertyResizable
When open, can a pane be resized?
Public propertyResizeChildLayout
Triggers child-layout.resizeAll() when this pane is resized.
Public propertyResizerClass
Prefix used for auto-generated classNames for each resizer bar.
Public propertyResizerCursor
Cursor when the mouse is over the resizer bar.
Public propertyResizerDragOpacity
Opacity of resizer bar when dragging to resize a pane.
Public propertyResizerTip
Tooltip shown when resizer-bar can be 'dragged' to resize a pane.
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 propertyShowOverflowOnHover
If 'true', then when moused-over, the pane's zIndex is raised and overflow is set to 'visible'. This allows pop-ups and drop-downs to overlap adjacent panes. WARNING: Enable this only for panes that do not scroll!
Public propertySize
Specifies the initial size of the panes - 'height' for north & south panes - 'width' for east and west. If PANE_AUTO_SIZE, then pane will size to fit its content - most useful for north/south panes (to auto-fit your banner or toolbar), but also works for east/west panes. You can use either absolute or percentage values.
Public propertySlidable
When closed, can a pane 'slide open' over adjacent panes?
Public propertySliderCursor
Cursor when resizer-bar triggers 'sliding open' (when pane is closed).
Public propertySliderTip
Tooltip when the resizer-bar triggers 'sliding open'.
Public propertySpacingClosed
Spacing between pane and adjacent pane - when pane is 'open' or 'closed'
Public propertySpacingOpen
Spacing between pane and adjacent pane when pane is open.
Public propertySrc
Represents src attribute of the rendered element. Applied when RenderAs==HtmlTextWriterTag.Iframe.
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertyTemplate
Template containing child controls.
Public propertyTogglerClass
Prefix used for auto-generated classNames for each toggler buttons.
Public propertyTogglerLengthClosed
Length of toggler-button when pane is 'closed'.
Public propertyTogglerLengthOpen
Length of toggler-button when pane is 'open'.
Public propertyTriggerEventsDuringLiveResize
True = trigger onresize callback REPEATEDLY if LivePaneResizing==true.
Public propertyUIContext
Control's UI Context
(Inherited from CMSUserControl.)
Public propertyUseCMSDeskAccessDeniedPage
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
(Inherited from CMSUserControl.)
Public propertyUsePseudoCloseCallback
Determines whether to use 'PseudoClose' callback for closing the pane. By default the value is true only when RenderAs==HtmlTextWriterTag.Iframe.
Public propertyUserControl
Control for renderascontrol mode.
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Public propertyUseUpdatePanel
If true, control is wrapped in UpdatePanel.
Public propertyValues
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
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 methodApplyPaneSettings
Fills given StringBuilder with pane settings.
Protected methodCreateChildControls
Creates child controls.
(Overrides ControlCreateChildControls.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
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 methodEvalDecimal
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the double.
(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.)
Protected methodGetAccessDeniedPageUrl
Returns access denied page with dependence on current setting.
(Inherited from CMSUserControl.)
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 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 methodGetValue(String)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodHasValue
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodOnContentLoaded
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.)
Protected methodOnInit
Init event handler.
(Inherited from AbstractUserControl.)
Protected methodOnLoad
Load event handler
(Overrides AbstractUserControlOnLoad(EventArgs).)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Public methodRaiseTabCreated
Raises OnTabCreated event.
Public methodRedirectToAccessDenied(String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(Int32, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(String, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToUIElementAccessDenied
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Public methodReleaseContext
Releases the control context.
(Inherited from CMSUserControl.)
Protected methodRender
Render event handler
(Overrides AbstractUserControlRender(HtmlTextWriter).)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSetContext
Sets the control context.
(Inherited from CMSUserControl.)
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
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 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.)
Protected methodTrackViewState
Tracks the view state.
(Inherited from InlineUserControl.)
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
Events
  NameDescription
Public eventOnTabCreated
Tab creation event.
Top
See Also