Click or drag to resize
MessagesPlaceHolder Class
Placeholder for messages.
Inheritance Hierarchy

Namespace: CMS.Base.Web.UI
Assembly: CMS.Base.Web.UI (in CMS.Base.Web.UI.dll) Version: 12.0.0
Syntax
C#
public class MessagesPlaceHolder : CMSPlaceHolder, 
	INamingContainer

The MessagesPlaceHolder type exposes the following members.

Constructors
  NameDescription
Public methodMessagesPlaceHolder
Constructor
Top
Properties
  NameDescription
Public propertyBasicStyles
Indicates if basic styles should be used
Public propertyConfirmation
Indicates if confirmation message should be displayed.
Public propertyConfirmationBasicCssClass
Confirmation message basic CSS class
Public propertyConfirmationDescription
Confirmation message description
Public propertyConfirmationLabel
Confirmation label.
Public propertyConfirmationText
Confirmation message text
Public propertyConfirmationTimeout
Timeout of the confirmation message
Public propertyConfirmationToolTip
Confirmation message tooltip
Public propertyContainerCssClass
CSS class for messages container
Public propertyErrorBasicCssClass
Error message basic CSS class
Public propertyErrorDescription
Error message description
Public propertyErrorLabel
Error label.
Public propertyErrorText
Error message text
Public propertyErrorTimeout
Timeout of the error message
Public propertyErrorToolTip
Error message tooltip
Public propertyHasText
Indicates whether any of the message labels contains text.
Public propertyInfoBasicCssClass
Information message basic CSS class
Public propertyInfoDescription
Information message description
Public propertyInfoLabel
Information label.
Public propertyInfoText
Information message text
Public propertyInfoTimeout
Timeout of the information message
Public propertyInfoToolTip
Information label tooltip
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSPlaceHolder.)
Public propertyLiveSiteOnly
Indicates that the placeholder should be used only for live site in context of control
Protected propertyMessageDescriptionLimit
Maximal length of message description.
Public propertyOffsetX
Offset of X coordinates
Public propertyOffsetY
Offset of Y coordinates
Public propertyOpacity
Opacity (0 - 100) of the messages panel (Applies only for dynamic messages. Default value is 87.)
Public propertyShortID
Short ID of the control.
(Inherited from CMSPlaceHolder.)
Public propertyTimeout
Timeout of the information or changes saved message
Public propertyUseRelativePlaceHolder
Indicates whether relative placeholder should be used to move original content
Public propertyWarningBasicCssClass
Warning message basic CSS class
Public propertyWarningDescription
Warning message description
Public propertyWarningLabel
Warning label.
Public propertyWarningText
Warning message text
Public propertyWarningTimeout
Timeout of the warning message
Public propertyWarningToolTip
Warning message tooltip
Public propertyWrapperControlClientID
Gets or sets the client control id of the wrapping control. Control offset and width is used to placeholder positioning
Public propertyWrapperControlID
Gets or sets the control id of the wrapping control. Control offset and width is used to placeholder positioning
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page, optionally with a tooltip text.
Public methodAddError
Adds error text to existing message on the page, optionally with a tooltip text.
Public methodAddInformation
Adds information text to existing message on the page, optionally with a tooltip text.
Public methodAddMessage
Adds text message.
Public methodAddWarning
Adds warning text to existing message on the page, optionally with a tooltip text.
Public methodAppend(String)
Appends the given content to the placeholder
(Inherited from CMSPlaceHolder.)
Public methodAppend(Control)
Appends the given control to the placeholder
(Inherited from CMSPlaceHolder.)
Public methodClear
Clears the placeholder content
(Inherited from CMSPlaceHolder.)
Public methodClearLabels
Clears labels text
Protected methodCreateChildControls
Creates child controls
(Overrides ControlCreateChildControls.)
Protected methodFinishCurrent
Appends the given content to the placeholder
(Inherited from CMSPlaceHolder.)
Public methodGetAnchorScript
Gets script for anchor
Protected methodGetEventLogType
Returns type of event log record based on given message type.
Protected methodLogMessageToEventLog
Logs message to event log.
Protected methodOnInit
Init event handler.
(Inherited from CMSPlaceHolder.)
Protected methodOnPreRender
PreRender event handler
(Overrides CMSPlaceHolderOnPreRender(EventArgs).)
Public methodPrependError
Prepends error text to existing message on the page, optionally with a tooltip text.
Protected methodRegisterScripts
Register required scripts
Protected methodRender
Render event
(Overrides ControlRender(HtmlTextWriter).)
Public methodShowChangesSaved
Shows the general changes saved message.
Public methodShowConfirmation
Shows the general confirmation message.
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
Public methodShowMessage
Shows the given message on the page, optionally with a tooltip text.
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
Top
Extension Methods
  NameDescription
Public Extension MethodCallHandled
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 MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
See Also