CMSDeviceLayout Class

Device layout block.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.PlaceHolder
      CMS.PortalControls.CMSConditionalLayout
        CMS.PortalControls.CMSDeviceLayout

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

Syntax

public class CMSDeviceLayout : CMSConditionalLayout

The CMSDeviceLayout type exposes the following members.

Constructors

	Name	Description
Public method	CMSDeviceLayout	Device layout constructor.

Fields

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

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 (Inherited from CMSConditionalLayout.)
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. (Inherited from CMSConditionalLayout.)
Public property	PagePlaceholder	Parent page placeholder. (Inherited from CMSConditionalLayout.)
Public property	Visible	Returns true if the layout is visible. (Inherited from CMSConditionalLayout.)
Public property	VisibleForDeviceProfiles	List of device profile names separated by semicolon in which current device must belong in order to display the layout (Overrides CMSConditionalLayout.VisibleForDeviceProfiles.)
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" (Inherited from CMSConditionalLayout.)
Public property	VisibleForDomains	List of domain names separated by semicolon for which the layout is displayed (Inherited from CMSConditionalLayout.)
Public property	VisibleForRoles	List of role names separated by semicolon to which the user must belong in order to display the layout (Inherited from CMSConditionalLayout.)
Public property	WebPartZones	Returns the list of all the inner web part zones (CMSWebPartZone controls). (Inherited from CMSConditionalLayout.)

Methods

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

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