UIElementLayout MembersKentico 8.0 API Reference
The UIElementLayout type exposes the following members.
Constructors

  NameDescription
Public methodUIElementLayout
Back to Top
Methods

  NameDescription
Protected methodOnlineAddAttributesToRender
Adds HTML attributes and styles that need to be rendered to the specified OnlineHtmlTextWriterTag. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Protected methodOnlineAddedControl
Called after a child control is added to the OnlineControls collection of the OnlineControl object.
(Inherited from OnlineControl.)
Protected methodOnlineAddParsedSubObject
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's OnlineControlCollection object.
(Inherited from OnlineControl.)
Public methodOnlineApplyStyle
Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
(Inherited from OnlineWebControl.)
Public methodOnlineApplyStyleSheetSkin
Applies the style properties defined in the page style sheet to the control.
(Inherited from OnlineControl.)
Protected methodOnlineBuildProfileTree
Gathers information about the server control and delivers it to the OnlineTrace property to be displayed when tracing is enabled for the page.
(Inherited from OnlineControl.)
Protected methodOnlineClearCachedClientID
Sets the cached OnlineClientID value to null.
(Inherited from OnlineControl.)
Protected methodOnlineClearEffectiveClientIDMode
Sets the OnlineClientIDMode property of the current control instance and of any child controls to OnlineInherit.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildControlState
Deletes the control-state information for the server control's child controls.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildState
Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildViewState
Deletes the view-state information for all the server control's child controls.
(Inherited from OnlineControl.)
Public methodOnlineCopyBaseAttributes
Copies the properties not encapsulated by the OnlineStyle object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Protected methodOnlineCreateControlCollection
Creates a new OnlineControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from OnlineControl.)
Protected methodOnlineCreateControlStyle
Creates the style object that is used internally by the OnlineWebControl class to implement all style related properties. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Protected methodOnlineCreateChildControls
Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.
(Inherited from OnlineControl.)
Public methodOnlineDataBind 
Binds a data source to the invoked server control and all its child controls.
(Inherited from OnlineControl.)
Protected methodOnlineDataBind(Boolean)
Binds a data source to the invoked server control and all its child controls with an option to raise the OnlineDataBinding event.
(Inherited from OnlineControl.)
Protected methodOnlineDataBindChildren
Binds a data source to the server control's child controls.
(Inherited from OnlineControl.)
Public methodOnlineDispose
Enables a server control to perform final clean up before it is released from memory.
(Inherited from OnlineControl.)
Protected methodOnlineEnsureChildControls
Determines whether the server control contains child controls. If it does not, it creates child controls.
(Inherited from OnlineControl.)
Protected methodOnlineEnsureID
Creates an identifier for controls that do not have an identifier assigned.
(Inherited from OnlineControl.)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineFindControl(String)
Searches the current naming container for a server control with the specified id parameter.
(Inherited from OnlineControl.)
Protected methodOnlineFindControl(String, Int32)
Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the OnlineFindControl  method.
(Inherited from OnlineControl.)
Public methodOnlineFocus
Sets input focus to a control.
(Inherited from OnlineControl.)
Protected methodOnlineGetDesignModeState
Gets design-time data for a control.
(Inherited from OnlineControl.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodOnlineGetRouteUrl(Object)
Gets the URL that corresponds to a set of route parameters.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(String, Object)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(String, RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from OnlineControl.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodOnlineGetUniqueIDRelativeTo
Returns the prefixed portion of the OnlineUniqueID property of the specified control.
(Inherited from OnlineControl.)
Public methodOnlineHasControls
Determines if the server control contains any child controls.
(Inherited from OnlineControl.)
Protected methodOnlineHasEvents
Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from OnlineControl.)
Protected methodOnlineIsLiteralContent
Determines if the server control holds only literal content.
(Inherited from OnlineControl.)
Protected methodOnlineLoadControlState
Restores control-state information from a previous page request that was saved by the OnlineSaveControlState  method.
(Inherited from OnlineControl.)
Protected methodOnlineLoadViewState
Restores view-state information from a previous request that was saved with the OnlineSaveViewState  method.
(Inherited from OnlineWebControl.)
Protected methodOnlineMapPathSecure
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from OnlineControl.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodOnlineMergeStyle
Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Protected methodOnlineOnBubbleEvent
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from OnlineControl.)
Protected methodOnlineOnDataBinding
Raises the OnlineDataBinding event.
(Inherited from OnlineControl.)
Protected methodOnInit
Init event handler
(Inherited from UILayout.)
Protected methodOnLoad
Load event handler
(Overrides OnlineControl OnLoad(EventArgs).)
Protected methodOnPreRender
PreRender event handler
(Inherited from UILayout.)
Protected methodOnlineOnUnload
Raises the OnlineUnload event.
(Inherited from OnlineControl.)
Protected methodOnlineOpenFile
Gets a OnlineStream used to read a file.
(Inherited from OnlineControl.)
Protected methodOnlineRaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
(Inherited from OnlineControl.)
Protected methodOnlineRemovedControl
Called after a child control is removed from the OnlineControls collection of the OnlineControl object.
(Inherited from OnlineControl.)
Protected methodOnlineRender
Renders the control to the specified HTML writer.
(Inherited from OnlineWebControl.)
Public methodOnlineRenderBeginTag
Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Protected methodOnlineRenderContents
Renders the contents of the control to the specified writer. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Public methodOnlineRenderControl(HtmlTextWriter)
Outputs server control content to a provided OnlineHtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(Inherited from OnlineControl.)
Protected methodOnlineRenderControl(HtmlTextWriter, ControlAdapter)
Outputs server control content to a provided OnlineHtmlTextWriter object using a provided OnlineControlAdapter object.
(Inherited from OnlineControl.)
Public methodOnlineRenderEndTag
Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Protected methodOnlineRenderChildren
Outputs the content of a server control's children to a provided OnlineHtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from OnlineControl.)
Protected methodOnlineResolveAdapter
Gets the control adapter responsible for rendering the specified control.
(Inherited from OnlineControl.)
Public methodOnlineResolveClientUrl
Gets a URL that can be used by the browser.
(Inherited from OnlineControl.)
Public methodOnlineResolveUrl
Converts a URL into one that is usable on the requesting client.
(Inherited from OnlineControl.)
Protected methodOnlineSaveControlState
Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from OnlineControl.)
Protected methodOnlineSaveViewState
Saves any state that was modified after the OnlineTrackViewState  method was invoked.
(Inherited from OnlineWebControl.)
Protected methodOnlineSetDesignModeState
Sets design-time data for a control.
(Inherited from OnlineControl.)
Public methodOnlineSetRenderMethodDelegate
Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from OnlineControl.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Protected methodOnlineTrackViewState
Causes the control to track changes to its view state so they can be stored in the object's OnlineViewState property.
(Inherited from OnlineWebControl.)
Back to Top
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 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.)
Back to Top
Fields

  NameDescription
Protected fieldmStopProcessing
Indicates if processing of the placeholder should be stopped.
(Inherited from UILayout.)
Back to Top
Properties

  NameDescription
Public propertyOnlineAccessKey
Gets or sets the access key that allows you to quickly navigate to the Web server control.
(Inherited from OnlineWebControl.)
Protected propertyOnlineAdapter
Gets the browser-specific adapter for the control.
(Inherited from OnlineControl.)
Public propertyApplyDemoStyles
When enabled, the layout will apply basic styles directly to resizers and buttons.
(Inherited from UILayout.)
Public propertyOnlineAppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the OnlinePage or OnlineUserControl object that contains this control.
(Inherited from OnlineControl.)
Public propertyOnlineAttributes
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
(Inherited from OnlineWebControl.)
Public propertyOnlineBackColor
Gets or sets the background color of the Web server control.
(Inherited from OnlineWebControl.)
Public propertyOnlineBindingContainer
Gets the control that contains this control's data binding.
(Inherited from OnlineControl.)
Public propertyOnlineBorderColor
Gets or sets the border color of the Web control.
(Inherited from OnlineWebControl.)
Public propertyOnlineBorderStyle
Gets or sets the border style of the Web server control.
(Inherited from OnlineWebControl.)
Public propertyOnlineBorderWidth
Gets or sets the border width of the Web server control.
(Inherited from OnlineWebControl.)
Public propertyOnlineClientID
Gets the control ID for HTML markup that is generated by ASP.NET.
(Inherited from OnlineControl.)
Public propertyOnlineClientIDMode
Gets or sets the algorithm that is used to generate the value of the OnlineClientID property.
(Inherited from OnlineControl.)
Protected propertyOnlineClientIDSeparator
Gets a character value representing the separator character used in the OnlineClientID property.
(Inherited from OnlineControl.)
Public propertyClosable
Can a pane be closed?
(Inherited from UILayout.)
Public propertyContainerSelector
Element the layout is created under. Most commonly 'body' element (default value). Can be any block-element.
(Inherited from UILayout.)
Protected propertyOnlineContext
Gets the OnlineHttpContext object associated with the server control for the current Web request.
(Inherited from OnlineControl.)
Public propertyOnlineControls
Gets a OnlineControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from OnlineControl.)
Public propertyOnlineControlStyle
Gets the style of the Web server control. This property is used primarily by control developers.
(Inherited from OnlineWebControl.)
Public propertyOnlineControlStyleCreated
Gets a value indicating whether a OnlineStyle object has been created for the OnlineControlStyle property. This property is primarily used by control developers.
(Inherited from OnlineWebControl.)
Public propertyOnlineCssClass
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
(Inherited from OnlineWebControl.)
Public propertyOnlineDataItemContainer
Gets a reference to the naming container if the naming container implements OnlineIDataItemContainer.
(Inherited from OnlineControl.)
Public propertyOnlineDataKeysContainer
Gets a reference to the naming container if the naming container implements OnlineIDataKeysControl.
(Inherited from OnlineControl.)
Protected propertyOnlineDesignMode
Gets a value indicating whether a control is being used on a design surface.
(Inherited from OnlineControl.)
Public propertyDisplayFooter
Indicates whether the footer pane should be displayed
Public propertyOnlineEnabled
Gets or sets a value indicating whether the Web server control is enabled.
(Inherited from OnlineWebControl.)
Public propertyOnlineEnableTheming
Gets or sets a value indicating whether themes apply to this control.
(Inherited from OnlineWebControl.)
Public propertyOnlineEnableViewState
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
(Inherited from OnlineControl.)
Protected propertyOnlineEvents
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from OnlineControl.)
Public propertyOnlineFont
Gets the font properties associated with the Web server control.
(Inherited from OnlineWebControl.)
Public propertyFooterControlPath
Gets or sets the path to the footer control.
Public propertyOnlineForeColor
Gets or sets the foreground color (typically the color of the text) of the Web server control.
(Inherited from OnlineWebControl.)
Public propertyOnlineHasAttributes
Gets a value indicating whether the control has attributes set.
(Inherited from OnlineWebControl.)
Protected propertyOnlineHasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from OnlineControl.)
Public propertyOnlineHeight
Gets or sets the height of the Web server control.
(Inherited from OnlineWebControl.)
Protected propertyOnlineChildControlsCreated
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from OnlineControl.)
Public propertyOnlineID
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from OnlineControl.)
Protected propertyOnlineIdSeparator
Gets the character used to separate control identifiers.
(Inherited from OnlineControl.)
Protected propertyOnlineIsEnabled
Gets a value indicating whether the control is enabled.
(Inherited from OnlineWebControl.)
Protected propertyOnlineIsChildControlStateCleared
Gets a value indicating whether controls contained within this control have control state.
(Inherited from OnlineControl.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Protected propertyOnlineIsTrackingViewState
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from OnlineControl.)
Protected propertyOnlineIsViewStateEnabled
Gets a value indicating whether view state is enabled for this control.
(Inherited from OnlineControl.)
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.
(Inherited from UILayout.)
Protected propertyOnlineLoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by OnlineID instead of index.
(Inherited from OnlineControl.)
Public propertyOnlineNamingContainer
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same OnlineID property value.
(Inherited from OnlineControl.)
Public propertyOnCloseEndScript
Script or function name called after 'close' is done.
(Inherited from UILayout.)
Public propertyOnCloseStartScript
Script or function name called before 'close' is done.
(Inherited from UILayout.)
Public propertyOnHideEndScript
Script or function name called after 'hide' is done.
(Inherited from UILayout.)
Public propertyOnHideStartScript
Script or function name called before 'hide' is done.
(Inherited from UILayout.)
Public propertyOnOpenEndScript
Script or function name called after 'open' is done.
(Inherited from UILayout.)
Public propertyOnOpenStartScript
Script or function name called before 'open' is done.
(Inherited from UILayout.)
Public propertyOnResizeEndScript
Script or function name called after 'resize' is done.
(Inherited from UILayout.)
Public propertyOnResizeStartScript
Script or function name called before 'resize' is done.
(Inherited from UILayout.)
Public propertyOnShowEndScript
Script or function name called after 'show' is done.
(Inherited from UILayout.)
Public propertyOnShowStartScript
Script or function name called before 'show' is done.
(Inherited from UILayout.)
Public propertyOnlinePage
Gets a reference to the OnlinePage instance that contains the server control.
(Inherited from OnlineControl.)
Public propertyPanes
Collection of panes. Cannot contain more than one pane for one direction (NESW or center).
(Inherited from UILayout.)
Public propertyOnlineParent
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from OnlineControl.)
Public propertyOnlineRenderingCompatibility
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from OnlineControl.)
Public propertyResizable
When open, can a pane be resized?
(Inherited from UILayout.)
Public propertyScrollToBookmarkOnLoad
This option handles of bookmarks that are passed on the URL of the page.
(Inherited from UILayout.)
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertyOnlineSite
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from OnlineControl.)
Public propertyOnlineSkinID
Gets or sets the skin to apply to the control.
(Inherited from OnlineWebControl.)
Public propertySlidable
When closed, can a pane 'slide open' over adjacent panes?
(Inherited from UILayout.)
Public propertyStopProcessing
Indicates if processing of the UI panel should be stopped.
(Inherited from UILayout.)
Public propertyOnlineStyle
Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
(Inherited from OnlineWebControl.)
Public propertyOnlineSupportsDisabledAttribute
Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's OnlineIsEnabled property is false.
(Inherited from OnlineWebControl.)
Public propertyOnlineTabIndex
Gets or sets the tab index of the Web server control.
(Inherited from OnlineWebControl.)
Protected propertyOnlineTagKey
Gets the OnlineHtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
(Inherited from OnlineWebControl.)
Protected propertyOnlineTagName
Gets the name of the control tag. This property is used primarily by control developers.
(Inherited from OnlineWebControl.)
Public propertyOnlineTemplateControl
Gets or sets a reference to the template that contains this control.
(Inherited from OnlineControl.)
Public propertyOnlineTemplateSourceDirectory
Gets the virtual directory of the OnlinePage or OnlineUserControl that contains the current server control.
(Inherited from OnlineControl.)
Public propertyOnlineToolTip
Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
(Inherited from OnlineWebControl.)
Public propertyUIContext
Returns control's UI context
(Inherited from CMSWebControl.)
Public propertyOnlineUniqueID
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from OnlineControl.)
Protected propertyOnlineViewState
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
(Inherited from OnlineControl.)
Protected propertyOnlineViewStateIgnoresCase
Gets a value that indicates whether the OnlineStateBag object is case-insensitive.
(Inherited from OnlineControl.)
Public propertyOnlineViewStateMode
Gets or sets the view-state mode of this control.
(Inherited from OnlineControl.)
Public propertyOnlineVisible
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from OnlineControl.)
Public propertyOnlineWidth
Gets or sets the width of the Web server control.
(Inherited from OnlineWebControl.)
Back to Top
Events

  NameDescription
Public eventOnlineDataBinding
Occurs when the server control binds to a data source.
(Inherited from OnlineControl.)
Public eventOnlineDisposed
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
(Inherited from OnlineControl.)
Public eventOnlineInit
Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from OnlineControl.)
Public eventOnlineLoad
Occurs when the server control is loaded into the OnlinePage object.
(Inherited from OnlineControl.)
Public eventOnlinePreRender
Occurs after the OnlineControl object is loaded but prior to rendering.
(Inherited from OnlineControl.)
Public eventOnlineUnload
Occurs when the server control is unloaded from memory.
(Inherited from OnlineControl.)
Back to Top
See Also