UILayoutPane Class |
Namespace: CMS.UIControls
public class UILayoutPane : CMSUserControl
The UILayoutPane type exposes the following members.
Name | Description | |
---|---|---|
UILayoutPane |
Name | Description | |
---|---|---|
PANE_AUTO_SIZE |
Constant for automatic size of a pane.
|
Name | Description | |
---|---|---|
AppendSrc |
Indicates whether append Src to layout pane. Used in situations when URL is set by another control.
| |
ApplyDemoStyles |
When enabled, the layout will apply basic styles directly to resizers & buttons.
| |
ButtonClass |
Prefix used for auto-generated classNames for each custom buttons.
| |
CheckPhysicalFile |
Indicates whether existence of ascx file should be checked
| |
Closable |
Can a pane be closed?
| |
ComponentName |
Component name
(Inherited from AbstractUserControl.) | |
Container |
Container to instantiate the template in.
| |
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.
| |
ContentSelector |
Selector string for INNER div/element. This div will auto-size so only it scrolls, and not the entire pane.
| |
ControlContext |
Control context.
(Inherited from CMSUserControl.) | |
ControlID |
Control ID
| |
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.)
| |
CurrentDocument |
Current document
(Inherited from AbstractUserControl.) | |
CurrentPageInfo |
Current page info
(Inherited from AbstractUserControl.) | |
CurrentResolver |
Control's resolver
(Inherited from CMSUserControl.) | |
CurrentSite |
Current site
(Inherited from AbstractUserControl.) | |
CurrentUser |
Current user
(Inherited from AbstractUserControl.) | |
Direction |
Direction (location) of the pane.
| |
DisplayMode |
Gets or sets display mode of the control.
(Inherited from CMSUserControl.) | |
DocumentManager |
Document manager control
(Inherited from AbstractUserControl.) | |
EditedObject |
Control's edited object
(Inherited from CMSUserControl.) | |
ElementName |
Code name of the UIElement.
| |
FrameBorder |
Indicates whether frame border should be rendered
| |
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 - {}).
| |
FxSettings |
If a non-standard effect is specified, then fxSettings is REQUIRED (can be empty though).
| |
FxSpeed |
Speed of animations – standard jQuery keyword like 'fast', or a millisecond value.
| |
HeaderActions |
Header actions control
(Inherited from AbstractUserControl.) | |
InitClosed |
Indicates if the pane is 'closed' when layout is created
| |
IsCMSDesk |
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.) | |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from AbstractUserControl.) | |
Item |
Gets or sets the value of the column.
(Inherited from InlineUserControl.) | |
LiveContentResizing |
True = re-measure header/footer heights as resizer is dragged.
| |
LivePaneResizing |
LIVE Resizing as resizer is dragged.
| |
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.
| |
MaxSize |
Maximum-size limit when resizing a pane (0 = as large as pane can go).
| |
MessagesPlaceHolder |
Placeholder for messages
(Inherited from AbstractUserControl.) | |
MinSize |
Minimum-size limit when resizing a pane (0 = as small as pane can go).
| |
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.
| |
ModuleName |
Code name of the module.
| |
NoFrames |
String that is rendered only along with iframe.
| |
OnCloseEndScript |
Script or function name called after 'close' is done.
| |
OnCloseStartScript |
Script or function name called before 'close' is done.
| |
OnHideEndScript |
Script or function name called after 'hide' is done.
| |
OnHideStartScript |
Script or function name called before 'hide' is done.
| |
OnOpenEndScript |
Script or function name called after 'open' is done.
| |
OnOpenStartScript |
Script or function name called before 'open' is done.
| |
OnResizeEndScript |
Script or function name called after 'resize' is done.
| |
OnResizeStartScript |
Script or function name called before 'resize' is done.
| |
OnShowEndScript |
Script or function name called after 'show' is done.
| |
OnShowStartScript |
Script or function name called before 'show' is done.
| |
PaneClass |
Prefix used for stylesheet classes related to this pane.
| |
Parameter |
Control parameter.
(Inherited from InlineUserControl.) | |
Properties |
Control properties.
(Inherited from InlineUserControl.) | |
QueryParameterName |
Name of URL query parameter that is used for tab preselection.
| |
RenderAs |
HTML tag representing the pane. Use block elements or iframe.
| |
RenderPane |
If true, the pane is rendered
| |
Resizable |
When open, can a pane be resized?
| |
ResizeChildLayout |
Triggers child-layout.resizeAll() when this pane is resized.
| |
ResizerClass |
Prefix used for auto-generated classNames for each resizer bar.
| |
ResizerCursor |
Cursor when the mouse is over the resizer bar.
| |
ResizerDragOpacity |
Opacity of resizer bar when dragging to resize a pane.
| |
ResizerTip |
Tooltip shown when resizer-bar can be 'dragged' to resize a pane.
| |
ResourcePrefix |
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.) | |
ResourcePrefixes |
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.) | |
ShortID |
Short ID of the control.
(Inherited from AbstractUserControl.) | |
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!
| |
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.
| |
Slidable |
When closed, can a pane 'slide open' over adjacent panes?
| |
SliderCursor |
Cursor when resizer-bar triggers 'sliding open' (when pane is closed).
| |
SliderTip |
Tooltip when the resizer-bar triggers 'sliding open'.
| |
SpacingClosed |
Spacing between pane and adjacent pane - when pane is 'open' or 'closed'
| |
SpacingOpen |
Spacing between pane and adjacent pane when pane is open.
| |
Src |
Represents src attribute of the rendered element. Applied when RenderAs==HtmlTextWriterTag.Iframe.
| |
StopProcessing |
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.) | |
Template |
Template containing child controls.
| |
TogglerClass |
Prefix used for auto-generated classNames for each toggler buttons.
| |
TogglerLengthClosed |
Length of toggler-button when pane is 'closed'.
| |
TogglerLengthOpen |
Length of toggler-button when pane is 'open'.
| |
TriggerEventsDuringLiveResize |
True = trigger onresize callback REPEATEDLY if LivePaneResizing==true.
| |
UIContext |
Control's UI Context
(Inherited from CMSUserControl.) | |
UseCMSDeskAccessDeniedPage |
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
(Inherited from CMSUserControl.) | |
UsePseudoCloseCallback |
Determines whether to use 'PseudoClose' callback for closing the pane.
By default the value is true only when RenderAs==HtmlTextWriterTag.Iframe.
| |
UserControl |
Control for renderascontrol mode.
| |
UsesLocalMessagesPlaceHolder |
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.) | |
UseUpdatePanel |
If true, control is wrapped in UpdatePanel.
| |
Values | ||
ViewState |
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.) |
Name | Description | |
---|---|---|
AddConfirmation |
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddError |
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddHeaderAction |
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.) | |
AddInformation |
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddMessage |
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddWarning |
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.) | |
ApplyPaneSettings |
Fills given StringBuilder with pane settings.
| |
CreateChildControls |
Creates child controls.
(Overrides ControlCreateChildControls.) | |
EnsureControls |
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.) | |
Eval(String) |
Evaluates the given value
(Inherited from AbstractUserControl.) | |
Eval(String, Boolean) |
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.) | |
EvalBool |
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.) | |
EvalDateTime |
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.) | |
EvalDecimal |
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.) | |
EvalDouble |
Evaluates the item data and converts it to the double.
(Inherited from AbstractUserControl.) | |
EvalGuid |
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.) | |
EvalHTML |
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.) | |
EvalHtmlAttribute |
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.) | |
EvalInteger |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.) | |
EvalJSString |
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.) | |
EvalText(String) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
EvalText(String, Boolean) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
GetAccessDeniedPageUrl |
Returns access denied page with dependence on current setting.
(Inherited from CMSUserControl.) | |
GetFlagIconUrl |
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.) | |
GetImagePath |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetImageUrl |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetString |
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.) | |
GetValue(String) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
GetValueReturnType(String, ReturnType) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
HasValue |
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.) | |
LoadUserControl |
Loads the user control based on the given path
(Inherited from AbstractUserControl.) | |
LogAndShowError |
Logs the exception and
(Inherited from AbstractUserControl.) | |
OnContentLoaded |
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.) | |
OnInit |
Init event handler.
(Inherited from AbstractUserControl.) | |
OnLoad |
Load event handler
(Overrides AbstractUserControlOnLoad(EventArgs).) | |
OnPreRender |
PreRender event handler.
(Inherited from AbstractUserControl.) | |
RaiseTabCreated |
Raises OnTabCreated event.
| |
RedirectToAccessDenied(String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
RedirectToAccessDenied(Int32, String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
RedirectToAccessDenied(String, String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
RedirectToUIElementAccessDenied |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
ReleaseContext |
Releases the control context.
(Inherited from CMSUserControl.) | |
Render |
Render event handler
(Overrides AbstractUserControlRender(HtmlTextWriter).) | |
ResolveUrl |
Resolves the given URL
(Inherited from AbstractUserControl.) | |
SetContext |
Sets the control context.
(Inherited from CMSUserControl.) | |
SetValue |
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.) | |
ShowChangesSaved |
Shows the general changes saved message.
(Inherited from AbstractUserControl.) | |
ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractUserControl.) | |
ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
TrackViewState |
Tracks the view state.
(Inherited from InlineUserControl.) |
Name | Description | |
---|---|---|
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.) | |
GetString |
Gets the string by the specified resource key
(Defined by ControlsExtensions.) |
Name | Description | |
---|---|---|
OnTabCreated |
Tab creation event.
|