UILayoutPane Class

Part of UI layout (can be center or one of cardinal directions).

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.ExtendedControls.AbstractUserControl
          CMS.ExtendedControls.InlineUserControl
            CMS.UIControls.CMSUserControl
              CMS.UIControls.UILayoutPane

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

Syntax

public class UILayoutPane : CMSUserControl

The UILayoutPane type exposes the following members.

Constructors

	Name	Description
Public method	UILayoutPane

Fields

	Name	Description
Protected field	mAccessDeniedPage	Access denied page (Inherited from CMSUserControl.)
Protected field	mCMSDeskAccessDeniedPage	CMSDesk access denied page (Inherited from CMSUserControl.)
Protected field	mControlContext	Control context (Inherited from CMSUserControl.)
Protected field	mControlGUID	Control GUID (Inherited from CMSUserControl.)
Protected field	mDisplayMode	Display mode (Inherited from CMSUserControl.)
Protected field	mRelativePath	Relative path (Inherited from CMSUserControl.)
Protected field	mUseCMSDeskAccessDeniedPage	Indicates whether CMSDesk access denied page should be used (Inherited from CMSUserControl.)
Protected field	mViewStateTracked	If true, the ViewState has been already tracked. (Inherited from InlineUserControl.)
Public field Static member	PANE_AUTO_SIZE	Constant for automatic size of a pane.

Properties

	Name	Description
Public property	AppendSrc	Indicates whether append Src to layout pane. Used in situations when URL is set by another control.
Public property	ApplyDemoStyles	When enabled, the layout will apply basic styles directly to resizers & buttons.
Public property	ButtonClass	Prefix used for auto-generated classNames for each custom buttons.
Public property	Closable	Can a pane be closed?
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	Container	Container to instantiate the template in.
Public property	ContentIgnoreSelector	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 property	ContentSelector	Selector string for INNER div/element. This div will auto-size so only it scrolls, and not the entire pane.
Public property	ControlContext	Control context. (Inherited from CMSUserControl.)
Public property	ControlGUID	Unique ID of the control within the given request. (Inherited from CMSUserControl.)
Public property	ControlID	Control ID
Public property	ControlPath	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 property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentResolver	Control's resolver (Inherited from CMSUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	Direction	Direction (location) of the pane.
Public property	DisplayMode	Gets or sets display mode of the control. (Inherited from CMSUserControl.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditedObject	Control's edited object (Inherited from AbstractUserControl.)
Public property	ElementName	Code name of the UIElement.
Public property	FrameBorder	Indicates whether frame border should be rendered
Public property	FxName	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 property	FxSettings	If a non-standard effect is specified, then fxSettings is REQUIRED (can be empty though).
Public property	FxSpeed	Speed of animations – standard jQuery keyword like 'fast', or a millisecond value.
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	CheckPhysicalFile	Indicates whether existence of ascx file should be checked
Public property	InitClosed	Indicates if the pane is 'closed' when layout is created
Public property	IsCMSDesk	Determines whether the current control lies on the page that is currently located under the CMS Desk. (Inherited from CMSUserControl.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	Item	Gets or sets the value of the column. (Inherited from InlineUserControl.)
Public property	LiveContentResizing	True = re-measure header/footer heights as resizer is dragged.
Public property	LivePaneResizing	LIVE Resizing as resizer is dragged.
Public property	MaskContents	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 property	MaxSize	Maximum-size limit when resizing a pane (0 = as large as pane can go).
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	MinSize	Minimum-size limit when resizing a pane (0 = as small as pane can go).
Public property	ModuleAvailabilityForSiteRequired	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 property	ModuleName	Code name of the module.
Public property	NoFrames	String that is rendered only along with iframe.
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	PaneClass	Prefix used for stylesheet classes related to this pane.
Public property	Parameter	Control parameter. (Inherited from InlineUserControl.)
Protected property	Properties	Control properties. (Inherited from InlineUserControl.)
Public property	QueryParameterName	Name of URL query parameter that is used for tab preselection.
Public property	RelativePath	Page relative path. (Inherited from CMSUserControl.)
Public property	RenderAs	HTML tag representing the pane. Use block elements or iframe.
Public property	RenderPane	If true, the pane is rendered
Public property	Resizable	When open, can a pane be resized?
Public property	ResizeChildLayout	Triggers child-layout.resizeAll() when this pane is resized.
Public property	ResizerClass	Prefix used for auto-generated classNames for each resizer bar.
Public property	ResizerCursor	Cursor when the mouse is over the resizer bar.
Public property	ResizerDragOpacity	Opacity of resizer bar when dragging to resize a pane.
Public property	ResizerTip	Tooltip shown when resizer-bar can be 'dragged' to resize a pane.
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	ShowOverflowOnHover	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 property	Size	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 property	Slidable	When closed, can a pane 'slide open' over adjacent panes?
Public property	SliderCursor	Cursor when resizer-bar triggers 'sliding open' (when pane is closed).
Public property	SliderTip	Tooltip when the resizer-bar triggers 'sliding open'.
Public property	SpacingClosed	Spacing between pane and adjacent pane - when pane is 'open' or 'closed'
Public property	SpacingOpen	Spacing between pane and adjacent pane when pane is open.
Public property	Src	Represents src attribute of the rendered element. Applied when RenderAs==HtmlTextWriterTag.Iframe.
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	Template	Template containing child controls.
Public property	TogglerClass	Prefix used for auto-generated classNames for each toggler buttons.
Public property	TogglerLengthClosed	Length of toggler-button when pane is 'closed'.
Public property	TogglerLengthOpen	Length of toggler-button when pane is 'open'.
Public property	TriggerEventsDuringLiveResize	True = trigger onresize callback REPEATEDLY if LivePaneResizing==true.
Public property	TypeName	Returns the object type name. (Inherited from CMSUserControl.)
Public property	UIContext	Control's UI Context (Inherited from AbstractUserControl.)
Public property	UseCMSDeskAccessDeniedPage	Gets or sets the value that indicates whether CMSDesk access denied page should be used. (Inherited from CMSUserControl.)
Public property	UsePseudoCloseCallback	Determines whether to use 'PseudoClose' callback for closing the pane. By default the value is true only when RenderAs==HtmlTextWriterTag.Iframe.
Public property	UserControl	Control for renderascontrol mode.
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Public property	UseUpdatePanel	If true, control is wrapped in UpdatePanel.
Public property	Values
Protected property	ViewState	ViewState - overridden for the Master page ViewState fix. (Inherited from InlineUserControl.)

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	ApplyPaneSettings	Fills given StringBuilder with pane settings.
Protected method	CreateChildControls	Creates child controls. (Overrides Control.CreateChildControls().)
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
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.)
Protected method	GetAccessDeniedPageUrl	Returns access denied page with dependence on current setting. (Inherited from CMSUserControl.)
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	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	GetValue(String)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	GetValue<ReturnType>(String, ReturnType)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	HasValue	Returns true if the value of the given property is set. (Inherited from InlineUserControl.)
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Public method	OnContentLoaded	Method that is called when the control content is loaded. (Inherited from InlineUserControl.)
Protected method	OnInit	Init event handler. (Inherited from AbstractUserControl.)
Protected method	OnLoad	Load event handler (Overrides CMSUserControl.OnLoad(EventArgs).)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Public method	RaiseTabCreated	Raises OnTabCreated event.
Public method	RedirectToAccessDenied(String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToAccessDenied(Int32, String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToAccessDenied(String, String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToUIElementAccessDenied	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Public method	ReleaseContext	Releases the control context. (Inherited from CMSUserControl.)
Protected method	Render	Render event handler (Overrides AbstractUserControl.Render(HtmlTextWriter).)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	SetContext	Sets the control context. (Inherited from CMSUserControl.)
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value. (Inherited from InlineUserControl.)
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.)
Protected method	TrackViewState	Tracks the view state. (Inherited from InlineUserControl.)

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

Events

	Name	Description
Public event	OnTabCreated	Tab creation event.