Click or drag to resize
CMSConditionalLayout Class
Conditional layout block.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsPlaceHolder
      CMS.PortalEngine.Web.UICMSConditionalLayout

Namespace: CMS.PortalEngine.Web.UI
Assembly: CMS.PortalEngine.Web.UI (in CMS.PortalEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class CMSConditionalLayout : PlaceHolder

The CMSConditionalLayout type exposes the following members.

Constructors
  NameDescription
Public methodCMSConditionalLayout
Top
Fields
  NameDescription
Protected fieldmGroupVisible
Returns the state of the visibility of the control within the group
Protected fieldmPagePlaceholder
Parent page placeholder.
Protected fieldmVisible
Returns true if the layout is visible.
Protected fieldmWebPartZones
List of the inner web part zones.
Top
Properties
  NameDescription
Public propertyActiveInDesignMode
If true, the layout behaves actively in design mode of the page, meaning that it evaluates it's display condition
Public propertyGroupName
Name of the layout group to which the layout belongs. If more layouts use the same group, only the first one that matches the visibility condition is displayed.
Public propertyPagePlaceholder
Parent page placeholder.
Public propertyVisible
Returns true if the layout is visible.
(Overrides ControlVisible.)
Public propertyVisibleForDocumentTypes
If true, the layout is shown only for given document types. The value contains list of document type class names separated by semicolon, e.g. "CMS.Article;CMS.Product"
Public propertyVisibleForDomains
List of domain names separated by semicolon for which the layout is displayed
Public propertyVisibleForRoles
List of role names separated by semicolon to which the user must belong in order to display the layout
Public propertyWebPartZones
Returns the list of all the inner web part zones (CMSWebPartZone controls).
Top
Methods
  NameDescription
Public methodCheckLayoutVisible
Checks whether the layout is visible or not and returns the state of the layout
Public methodDataBind
Binds a data source to the invoked server control and all its child controls.
(Overrides ControlDataBind.)
Protected methodOnLoad
Load event handler
(Overrides ControlOnLoad(EventArgs).)
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
See Also