Click or drag to resize
CMSUserControl Class
Base class for CMS administration interface control.
Inheritance Hierarchy

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 9.0.0
Syntax
C#
public abstract class CMSUserControl : InlineUserControl

The CMSUserControl type exposes the following members.

Constructors
  NameDescription
Protected methodCMSUserControl
Top
Fields
  NameDescription
Protected fieldmAccessDeniedPage
Access denied page
Protected fieldmCMSDeskAccessDeniedPage
CMSDesk access denied page
Protected fieldmControlContext
Control context
Protected fieldmControlGUID
Control GUID
Protected fieldmDisplayMode
Display mode
Protected fieldmRelativePath
Relative path
Protected fieldmUseCMSDeskAccessDeniedPage
Indicates whether CMSDesk access denied page should be used
Protected fieldmViewStateTracked
If true, the ViewState has been already tracked.
(Inherited from InlineUserControl.)
Top
Properties
  NameDescription
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyControlContext
Control context.
Public propertyControlGUID
Unique ID of the control within the given request.
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentResolver
Control's resolver
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDisplayMode
Gets or sets display mode of the control.
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from AbstractUserControl.)
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyIsCMSDesk
Determines whether the current control lies on the page that is currently located under the CMS Desk.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyParameter
Control parameter.
(Inherited from InlineUserControl.)
Protected propertyProperties
Control properties.
(Inherited from InlineUserControl.)
Public propertyRelativePath
Page relative path.
Public propertyCode exampleResourcePrefix
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertyTypeName
Returns the object type name.
Public propertyUIContext
Control's UI Context
(Inherited from AbstractUserControl.)
Public propertyUseCMSDeskAccessDeniedPage
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Protected methodGetAccessDeniedPageUrl
Returns access denied page with dependence on current setting.
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Public methodGetValue(String)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodHasValue
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodOnContentLoaded
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.)
Protected methodOnInit
Init event handler.
(Inherited from AbstractUserControl.)
Protected methodOnLoad
OnLoad override, setup access denied page with dependence on current usage.
(Overrides AbstractUserControlOnLoad(EventArgs).)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Public methodRedirectToAccessDenied(String)
Redirects the user to Access denied page.
Protected methodRedirectToAccessDenied(Int32, String)
Redirects the user to Access denied page.
Protected methodRedirectToAccessDenied(String, String)
Redirects the user to Access denied page.
Public methodStatic memberRedirectToInformation
Redirects the user to the info page which displays specified message.
Protected methodRedirectToUIElementAccessDenied
Redirects the user to Access denied page.
Public methodStatic memberRedirectToUINotAvailable
Redirects the user to the info page which says that the UI of the requested page is not available.
Public methodReleaseContext
Releases the control context.
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSetContext
Sets the control context.
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodTrackViewState
Tracks the view state.
(Inherited from InlineUserControl.)
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
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UITemplateControl
      System.Web.UIUserControl
        CMS.ExtendedControlsAbstractUserControl
          CMS.ExtendedControlsInlineUserControl
            CMS.UIControlsCMSUserControl
              CMS.BlogsBlogCommentDetail
              CMS.EcommerceCheckBoxWithDropDown
              CMS.EcommerceProductOptionSelector
              CMS.EcommerceProviderShoppingCartStep
              CMS.ForumsForumViewer
              CMS.MediaLibraryMediaFilePreview
              CMS.MessageBoardsBoardMessageActions
              CMS.NotificationsCMSNotificationGatewayForm
              CMS.NotificationsCMSNotificationSubscription
              CMS.NotificationsTemplateTextEdit
              CMS.OnlineMarketingActivityDetail
              CMS.UIControlsAdvancedExport
              CMS.UIControlsAsyncControl
              CMS.UIControlsBaseFieldEditor
              CMS.UIControlsBaseSchedulingControl
              CMS.UIControlsBreadcrumbs
              CMS.UIControlsCloneSettingsControl
              CMS.UIControlsCMSAbstractNewDocumentControl
              CMS.UIControlsCMSAdminControl
              CMS.UIControlsContentActionsControl
              CMS.UIControlsContentInnerMediaView
              CMS.UIControlsDocumentFlagsControl
              CMS.UIControlsDocumentValidator
              CMS.UIControlsErrorMessageControl
              CMS.UIControlsExportModuleControl
              CMS.UIControlsHelpControl
              CMS.UIControlsImportExportBase
              CMS.UIControlsImportExportControl
              CMS.UIControlsItemProperties
              CMS.UIControlsLogControl
              CMS.UIControlsMacroBoolExpression
              CMS.UIControlsMacroTree
              CMS.UIControlsMediaView
              CMS.UIControlsPageTitle
              CMS.UIControlsSettingsGroup
              CMS.UIControlsSqlEditControl
              CMS.UIControlsUILayoutPane
              CMS.UIControlsUIMenu
              CMS.UIControlsUIPager
              CMS.UIControlsUITabs
              CMS.UIControlsUIToolbar
              CMS.UIControlsUniButton
              CMS.UIControlsUniGraphToolbar
              CMS.UIControlsUniGrid
              CMS.UIControlsUniMatrix
              CMS.UIControlsUniTree
              CMS.UIControlsValuesTable
              CMS.UIControlsVersionHistoryControl