CMSConditionalLayout Class

Conditional layout block.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.PlaceHolder
      CMS.PortalEngine.Web.UI.CMSConditionalLayout

Namespace: CMS.PortalEngine.Web.UI
Assembly: CMS.PortalEngine.Web.UI (in CMS.PortalEngine.Web.UI.dll) Version: 13.0.131

Syntax

public class CMSConditionalLayout : PlaceHolder

The CMSConditionalLayout type exposes the following members.

Constructors

	Name	Description
Public method	CMSConditionalLayout

Fields

	Name	Description
Protected field	mGroupVisible	Returns the state of the visibility of the control within the group
Protected field	mPagePlaceholder	Parent page placeholder.
Protected field	mVisible	Returns true if the layout is visible.
Protected field	mWebPartZones	List of the inner web part zones.

Properties

	Name	Description
Public property	ActiveInDesignMode	If true, the layout behaves actively in design mode of the page, meaning that it evaluates it's display condition
Public property	GroupName	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 property	PagePlaceholder	Parent page placeholder.
Public property	Visible	Returns true if the layout is visible. (Overrides Control.Visible.)
Public property	VisibleForDocumentTypes	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 property	VisibleForDomains	List of domain names separated by semicolon for which the layout is displayed
Public property	VisibleForRoles	List of role names separated by semicolon to which the user must belong in order to display the layout
Public property	WebPartZones	Returns the list of all the inner web part zones (CMSWebPartZone controls).

Methods

	Name	Description
Public method	CheckLayoutVisible	Checks whether the layout is visible or not and returns the state of the layout
Public method	DataBind	Binds a data source to the invoked server control and all its child controls. (Overrides Control.DataBind().)
Protected method	OnLoad	Load event handler (Overrides Control.OnLoad(EventArgs).)

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