AbstractUserControl Class

User control base.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.ExtendedControls.AbstractUserControl
          More...

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

Syntax

public abstract class AbstractUserControl : UserControl, 
	IEnsureControls, IShortID, IResourcePrefixManager

The AbstractUserControl type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractUserControl

Properties

	Name	Description
Public property	ComponentName	Component name
Public property	CurrentDocument	Current document
Public property	CurrentPageInfo	Current page info
Public property	CurrentSite	Current site
Public property	CurrentUser	Current user
Public property	DocumentManager	Document manager control
Public property	EditedObject	Control's edited object
Public property	HeaderActions	Header actions control
Public property	IsLiveSite	Indicates if control is used on live site.
Public property	MessagesPlaceHolder	Placeholder for messages
Public property Code example	ResourcePrefix	Prefix for the resource strings which are used for the localization by the control and its child controls.
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy
Public property	ShortID	Short ID of the control.
Public property	StopProcessing	Indicates if the control should perform the operations.
Public property	UIContext	Control's UI Context
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page.
Public method	AddError	Adds error text to existing message on the page.
Public method	AddHeaderAction	Adds specified action to the page header actions.
Public method	AddInformation	Adds information text to existing message on the page.
Public method	AddMessage	Adds message text to existing message on the page.
Public method	AddWarning	Adds warning text to existing message on the page.
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls
Public method	Eval(String)	Evaluates the given value
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding.
Public method	Eval<ReturnType>(String)	Templated Eval, returns the value converted to specific type.
Public method	EvalBool	Evaluates the item data and converts it to the bool.
Public method	EvalDateTime	Evaluates the item data and converts it to the date time.
Public method	EvalDouble	Evaluates the item data and converts it to the integer.
Public method	EvalGuid	Evaluates the item data and converts it to the guid.
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute.
Public method	EvalInteger	Evaluates the item data and converts it to the integer.
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
Public method	EvalText(String, Boolean)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture.
Public method	GetImagePath	Gets UI image relative path.
Public method	GetImageUrl	Gets UI image relative path.
Public method	GetString	Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
Public method	LoadUserControl	Loads the user control based on the given path
Public method	LogAndShowError	Logs the exception and
Protected method	OnInit	Init event handler. (Overrides UserControl.OnInit(EventArgs).)
Protected method	OnLoad	Load event handler. (Overrides Control.OnLoad(EventArgs).)
Protected method	OnPreRender	PreRender event handler. (Overrides Control.OnPreRender(EventArgs).)
Protected method	Render	Render event handler. (Overrides Control.Render(HtmlTextWriter).)
Public method	ResolveUrl	Resolves the given URL
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(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text.
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, 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.)
Public Extension Method	SetShortID	Sets the short ID to the ID if available. (Defined by ControlsExtensions.)

Events

	Name	Description
Public event Static member	OnAfterUserControlInit	Fires after UserControl Init.
Public event Static member	OnAfterUserControlLoad	Fires after UserControl Load.
Public event Static member	OnAfterUserControlPreRender	Fires after UserControl PreRender.
Public event Static member	OnAfterUserControlRender	Fires after UserControl Render.
Public event Static member	OnBeforeUserControlInit	Fires before UserControl Init.
Public event Static member	OnBeforeUserControlLoad	Fires before UserControl Load.
Public event Static member	OnBeforeUserControlPreRender	Fires before UserControl PreRender.
Public event Static member	OnBeforeUserControlRender	Fires before UserControl Render.