Click or drag to resize
AbstractUserControl Class
User control base.
Inheritance Hierarchy

Namespace: CMS.Base.Web.UI
Assembly: CMS.Base.Web.UI (in CMS.Base.Web.UI.dll) Version: 10.0.0
Syntax
C#
public abstract class AbstractUserControl : UserControl, 
	IEnsureControls, IShortID, IResourcePrefixManager

The AbstractUserControl type exposes the following members.

Constructors
  NameDescription
Protected methodAbstractUserControl
Top
Properties
  NameDescription
Public propertyComponentName
Component name
Public propertyCurrentDocument
Current document
Public propertyCurrentPageInfo
Current page info
Public propertyCurrentSite
Current site
Public propertyCurrentUser
Current user
Public propertyDocumentManager
Document manager control
Public propertyHeaderActions
Header actions control
Public propertyIsLiveSite
Indicates if control is used on live site.
Public propertyMessagesPlaceHolder
Placeholder for messages
Public propertyCode exampleResourcePrefix
Prefix for the resource strings which are used for the localization by the control and its child controls.
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
Public propertyShortID
Short ID of the control.
Public propertyStopProcessing
Indicates if the control should perform the operations.
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
Public methodAddError
Adds error text to existing message on the page.
Public methodAddHeaderAction
Adds specified action to the page header actions.
Public methodAddInformation
Adds information text to existing message on the page.
Public methodAddMessage
Adds message text to existing message on the page.
Public methodAddWarning
Adds warning text to existing message on the page.
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
Public methodEval(String)
Evaluates the given value
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
Public methodEvalReturnType(String)
Templated Eval, returns the value converted to specific type.
Public methodEvalBool
Evaluates the item data and converts it to the bool.
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
Public methodEvalDouble
Evaluates the item data and converts it to the integer.
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
Public methodGetImagePath
Gets UI image relative path.
Public methodGetImageUrl
Gets UI image relative path.
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
Public methodLoadUserControl
Loads the user control based on the given path
Public methodLogAndShowError
Logs the exception and
Protected methodOnInit
Init event handler.
(Overrides UserControlOnInit(EventArgs).)
Protected methodOnLoad
Load event handler.
(Overrides ControlOnLoad(EventArgs).)
Protected methodOnPreRender
PreRender event handler.
(Overrides ControlOnPreRender(EventArgs).)
Protected methodRender
Render event handler.
(Overrides ControlRender(HtmlTextWriter).)
Public methodResolveUrl
Resolves the given URL
Public methodShowConfirmation
Shows the general confirmation message.
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
Public methodShowChangesSaved
Shows the general changes saved message.
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, 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.)
Public Extension MethodSetShortID
Sets the short ID to the ID if available.
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventStatic memberOnAfterUserControlInit
Fires after UserControl Init.
Public eventStatic memberOnAfterUserControlLoad
Fires after UserControl Load.
Public eventStatic memberOnAfterUserControlPreRender
Fires after UserControl PreRender.
Public eventStatic memberOnAfterUserControlRender
Fires after UserControl Render.
Public eventStatic memberOnBeforeUserControlInit
Fires before UserControl Init.
Public eventStatic memberOnBeforeUserControlLoad
Fires before UserControl Load.
Public eventStatic memberOnBeforeUserControlPreRender
Fires before UserControl PreRender.
Public eventStatic memberOnBeforeUserControlRender
Fires before UserControl Render.
Top
See Also
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UITemplateControl
      System.Web.UIUserControl
        CMS.Base.Web.UIAbstractUserControl
          CMS.Base.Web.UIAbstractRatingControl
          CMS.Base.Web.UICMSContextMenuControl
          CMS.Base.Web.UICMSCustomCalendarControl
          CMS.Base.Web.UIHeaderActions
          CMS.Base.Web.UIInlineUserControl
          CMS.DocumentEngine.Web.UICMSAbstractBaseFilterControl
          CMS.DocumentEngine.Web.UICMSAbstractTransformation
          CMS.Ecommerce.Web.UICMSPaymentGatewayForm
          CMS.FormEngine.Web.UICMSAbstractFormLayout
          CMS.FormEngine.Web.UICMSAbstractManagerEventArgsType, SimpleEventArgsType
          CMS.PortalEngine.Web.UICMSAbstractLayout
          CMS.PortalEngine.Web.UICMSAbstractPortalUserControl
          CMS.PortalEngine.Web.UICMSAbstractWebPart