MessagesPlaceHolder Class

Placeholder for messages.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.PlaceHolder
      CMS.ExtendedControls.CMSPlaceHolder
        CMS.ExtendedControls.MessagesPlaceHolder

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

Syntax

public class MessagesPlaceHolder : CMSPlaceHolder, 
	INamingContainer

The MessagesPlaceHolder type exposes the following members.

Constructors

	Name	Description
Public method	MessagesPlaceHolder	Constructor

Properties

	Name	Description
Public property	BasicStyles	Indicates if basic styles should be used
Public property	Confirmation	Indicates if confirmation message should be displayed.
Public property	ConfirmationBasicCssClass	Confirmation message basic CSS class
Public property	ConfirmationDescription	Confirmation message description
Public property	ConfirmationLabel	Confirmation label.
Public property	ConfirmationText	Confirmation message text
Public property	ConfirmationTimeout	Timeout of the confirmation message
Public property	ConfirmationToolTip	Confirmation message tooltip
Public property	ContainerCssClass	CSS class for messages container
Public property	ErrorBasicCssClass	Error message basic CSS class
Public property	ErrorDescription	Error message description
Public property	ErrorLabel	Error label.
Public property	ErrorText	Error message text
Public property	ErrorTimeout	Timeout of the error message
Public property	ErrorToolTip	Error message tooltip
Public property	HasText	Indicates whether any of the message labels contains text.
Public property	InfoBasicCssClass	Information message basic CSS class
Public property	InfoDescription	Information message description
Public property	InfoLabel	Information label.
Public property	InfoText	Information message text
Public property	InfoTimeout	Timeout of the information message
Public property	InfoToolTip	Information label tooltip
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSPlaceHolder.)
Public property	LiveSiteOnly	Indicates that the placeholder should be used only for live site in context of control
Protected property	MessageDescriptionLimit	Maximal length of message description.
Public property	OffsetX	Offset of X coordinates
Public property	OffsetY	Offset of Y coordinates
Public property	Opacity	Opacity (0 - 100) of the messages panel (Applies only for dynamic messages. Default value is 87.)
Public property	ShortID	Short ID of the control. (Inherited from CMSPlaceHolder.)
Public property	Timeout	Timeout of the information or changes saved message
Public property	UseRelativePlaceHolder	Indicates whether relative placeholder should be used to move original content
Public property	WarningBasicCssClass	Warning message basic CSS class
Public property	WarningDescription	Warning message description
Public property	WarningLabel	Warning label.
Public property	WarningText	Warning message text
Public property	WarningTimeout	Timeout of the warning message
Public property	WarningToolTip	Warning message tooltip
Public property	WrapperControlClientID	Gets or sets the client control id of the wrapping control. Control offset and width is used to placeholder positioning
Public property	WrapperControlID	Gets or sets the control id of the wrapping control. Control offset and width is used to placeholder positioning

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page, optionally with a tooltip text.
Public method	AddError	Adds error text to existing message on the page, optionally with a tooltip text.
Public method	AddInformation	Adds information text to existing message on the page, optionally with a tooltip text.
Public method	AddMessage	Adds text message.
Public method	AddWarning	Adds warning text to existing message on the page, optionally with a tooltip text.
Public method	Append(String[])	Appends the given content to the placeholder (Inherited from CMSPlaceHolder.)
Public method	Append(Control)	Appends the given control to the placeholder (Inherited from CMSPlaceHolder.)
Public method	Clear	Clears the placeholder content (Inherited from CMSPlaceHolder.)
Public method	ClearLabels	Clears labels text
Protected method	CreateChildControls	Creates child controls (Overrides Control.CreateChildControls().)
Protected method	FinishCurrent	Appends the given content to the placeholder (Inherited from CMSPlaceHolder.)
Public method	GetAnchorScript	Gets script for anchor
Protected method	GetEventLogType	Returns type of event log record based on given message type.
Protected method	LogMessageToEventLog	Logs message to event log.
Protected method	OnInit	Init event handler. (Inherited from CMSPlaceHolder.)
Protected method	OnPreRender	PreRender event handler (Overrides CMSPlaceHolder.OnPreRender(EventArgs).)
Public method	PrependError	Prepends error text to existing message on the page, optionally with a tooltip text.
Protected method	RegisterScripts	Register required scripts
Protected method	Render	Render event (Overrides Control.Render(HtmlTextWriter).)
Public method	ShowConfirmation	Shows the general confirmation message.
Public method	ShowError	Shows the specified error message, optionally with a tooltip text.
Public method	ShowChangesSaved	Shows the general changes saved message.
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text.
Public method	ShowMessage	Shows the given message on the page, optionally with a tooltip text.
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text.

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