UIPlaceHolder Class

Server control which represents container for UI element of the page.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.PlaceHolder
      CMS.UIControls.UIPlaceHolder

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

Syntax

public class UIPlaceHolder : PlaceHolder

The UIPlaceHolder type exposes the following members.

Constructors

	Name	Description
Public method	UIPlaceHolder

Fields

	Name	Description
Protected field	mIsHidden	False if user is either global administrator or is authorized to see specified UI element of the specified module, otherwise true.

Properties

	Name	Description
Public property	AlwaysVisible	If true, the control doesn't perform the permission check and is always visible
Public property	ElementName	Code name of the UIElement.
Public property	IsHidden	Returns false if user is either global administrator or is authorized to see specified UI element of the specified module, otherwise returns true.
Public property	ModuleName	Code name of the module.
Public property	PermissionName	Code name of the Permission.
Public property	StopProcessing	Indicates if processing of the UI panel should be stopped.

Methods

	Name	Description
Protected method	OnInit	Raises the Init event. (Overrides Control.OnInit(EventArgs).)
Protected method	Render	Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Overrides Control.Render(HtmlTextWriter).)

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

Events

	Name	Description
Public event	OnBeforeCheck	Fires before the main visibility check.
Public event	OnIsHidden	Fires to find out whether the place holder is hidden.