CMSMasterPage Class

Base class for administration master pages.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        System.Web.UI.MasterPage
          CMS.UIControls.AbstractMasterPage
            CMS.UIControls.CMSMasterPage

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 12.0.0

Syntax

public abstract class CMSMasterPage : AbstractMasterPage, 
	ICMSMasterPage

The CMSMasterPage type exposes the following members.

Constructors

	Name	Description
Protected method	CMSMasterPage

Fields

	Name	Description
Protected field	lblError	Error label control. (Inherited from AbstractMasterPage.)
Protected field	lblInfo	Info label control. (Inherited from AbstractMasterPage.)
Protected field	lblWarning	Warning label control. (Inherited from AbstractMasterPage.)
Protected field	mBodyClass	Body CSS class. (Inherited from AbstractMasterPage.)
Protected field	plcMessages	Placeholder for messages. (Inherited from AbstractMasterPage.)

Properties

	Name	Description
Public property	ActionsViewstateEnabled	Indicates if header actions panel should have ViewState enabled or disabled. (Inherited from AbstractMasterPage.)
Public property	AfterFormPlaceholder	Gets placeholder located after form element. (Inherited from AbstractMasterPage.)
Public property	Body	Body object. (Inherited from AbstractMasterPage.)
Public property	BodyClass	Body class. (Inherited from AbstractMasterPage.)
Public property	ButtonClose	Prepared for closing modal window. (Inherited from AbstractMasterPage.)
Public property	ButtonNext	Prepared for switching to next record (info/details etc.) (Inherited from AbstractMasterPage.)
Public property	ButtonPrevious	Prepared for switching to previous record (info/details etc.) (Inherited from AbstractMasterPage.)
Public property	DisplayActionsPanel	Indicates whether the panel for actions should be displayed. (Inherited from AbstractMasterPage.)
Public property	DisplayControlsPanel	Indicates whether the panel for additional controls should be displayed. (Inherited from AbstractMasterPage.)
Public property	DisplaySeparatorPanel	Indicates whether sparator should be displayed (Inherited from AbstractMasterPage.)
Public property	DisplaySiteSelectorPanel	Indicates whether the panel for site selector should be displayed (Inherited from AbstractMasterPage.)
Public property	ErrorLabel	Error label control. (Inherited from AbstractMasterPage.)
Public property	FooterContainer	Container with footer panel. (Inherited from AbstractMasterPage.)
Public property	HeadElements	Prepared for specifying the additional HEAD elements. (Inherited from AbstractMasterPage.)
Public property	HeaderActions	HeaderActions control. (Inherited from AbstractMasterPage.)
Public property	HeaderActionsPlaceHolder	HeaderActionsPermissions place holder. (Inherited from AbstractMasterPage.)
Public property	HeaderContainer	Header container. (Inherited from AbstractMasterPage.)
Public property	InfoLabel	Info label control. (Inherited from AbstractMasterPage.)
Public property	LinkExport	Prepared for exporting. (Inherited from AbstractMasterPage.)
Public property	MessagesPlaceHolder	Messages placeholder (Inherited from AbstractMasterPage.)
Public property	ObjectEditMenu	Container with header actions menu (Inherited from AbstractMasterPage.)
Public property	PageStatusContainer	Page status container. (Inherited from AbstractMasterPage.)
Public property	PanelBody	Body panel. (Inherited from AbstractMasterPage.)
Public property	PanelContainer	Tabs container panel. (Inherited from AbstractMasterPage.)
Public property	PanelContent	Gets the content panel. (Inherited from AbstractMasterPage.)
Public property	PanelFooter	Footer panel. (Inherited from AbstractMasterPage.)
Public property	PanelHeader	Header panel. (Inherited from AbstractMasterPage.)
Public property	PanelInfo	Info panel. (Inherited from AbstractMasterPage.)
Public property	PanelLeft	Left tabs panel. (Inherited from AbstractMasterPage.)
Public property	PanelRight	Right tabs panel. (Inherited from AbstractMasterPage.)
Public property	PanelSeparator	Separator panel. (Inherited from AbstractMasterPage.)
Public property	PanelTabs	Tabs panel. (Inherited from AbstractMasterPage.)
Public property	PanelTitle	Panel containing title. (Inherited from AbstractMasterPage.)
Public property	PanelTitleActions	Panel containing title actions displayed above scrolling content. (Inherited from AbstractMasterPage.)
Public property	PlaceholderLabels	Gets the labels container. (Inherited from AbstractMasterPage.)
Public property	TabMode	Indicates if the page is in tab mode. (Inherited from AbstractMasterPage.)
Public property	Tabs	Tabs control. (Inherited from AbstractMasterPage.)
Public property	Title	PageTitle control. (Inherited from AbstractMasterPage.)
Public property	WarningLabel	Warning label control. (Inherited from AbstractMasterPage.)

Methods

	Name	Description
Protected method	EnsureMessagesPlaceHolder	Ensures message labels on the page. (Inherited from AbstractMasterPage.)
Public method	HidePageTitle	Hide page title if page is used in tab mode.
Protected method	OnInit	Init event handler. (Overrides AbstractMasterPage.OnInit(EventArgs).)
Protected method	OnPreRender	PreRender event handler. (Overrides AbstractMasterPage.OnPreRender(EventArgs).)
Public method	SetBrowserClass	Sets the browser class to the body class.
Public method	SetRTL	Sets the RTL culture to the body class if RTL language.
Protected method	SetShortIDs	Sets the short IDs to the controls. (Inherited from AbstractMasterPage.)

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