CMSUserControl Class |
Namespace: CMS.UIControls
public abstract class CMSUserControl : InlineUserControl
The CMSUserControl type exposes the following members.
Name | Description | |
---|---|---|
CMSUserControl |
Name | Description | |
---|---|---|
ComponentName |
Component name
(Inherited from AbstractUserControl.) | |
ControlContext |
Control context.
| |
CurrentDocument |
Current document
(Inherited from AbstractUserControl.) | |
CurrentPageInfo |
Current page info
(Inherited from AbstractUserControl.) | |
CurrentResolver |
Control's resolver
| |
CurrentSite |
Current site
(Inherited from AbstractUserControl.) | |
CurrentUser |
Current user
(Inherited from AbstractUserControl.) | |
DisplayMode |
Gets or sets display mode of the control.
| |
DocumentManager |
Document manager control
(Inherited from AbstractUserControl.) | |
EditedObject |
Control's edited object
| |
HeaderActions |
Header actions control
(Inherited from AbstractUserControl.) | |
IsCMSDesk |
Determines whether the current control lies on the page that is currently located under the CMS Desk.
| |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from AbstractUserControl.) | |
Item |
Gets or sets the value of the column.
(Inherited from InlineUserControl.) | |
MessagesPlaceHolder |
Placeholder for messages
(Inherited from AbstractUserControl.) | |
Parameter |
Control parameter.
(Inherited from InlineUserControl.) | |
Properties |
Control properties.
(Inherited from InlineUserControl.) | |
RelativePath | Obsolete.
Page relative path.
| |
ResourcePrefix |
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.) | |
ResourcePrefixes |
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.) | |
ShortID |
Short ID of the control.
(Inherited from AbstractUserControl.) | |
StopProcessing |
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.) | |
TypeName | Obsolete.
Returns the object type name.
| |
UIContext |
Control's UI Context
| |
UseCMSDeskAccessDeniedPage |
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
| |
UsesLocalMessagesPlaceHolder |
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.) | |
ViewState |
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.) |
Name | Description | |
---|---|---|
AddConfirmation |
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddError |
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddHeaderAction |
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.) | |
AddInformation |
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddMessage |
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddWarning |
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.) | |
EnsureControls |
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.) | |
Eval(String) |
Evaluates the given value
(Inherited from AbstractUserControl.) | |
Eval(String, Boolean) |
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.) | |
EvalBool |
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.) | |
EvalDateTime |
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.) | |
EvalDecimal |
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.) | |
EvalDouble |
Evaluates the item data and converts it to the double.
(Inherited from AbstractUserControl.) | |
EvalGuid |
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.) | |
EvalHTML |
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.) | |
EvalHtmlAttribute |
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.) | |
EvalInteger |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.) | |
EvalJSString |
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.) | |
EvalText(String) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
EvalText(String, Boolean) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
GetAccessDeniedPageUrl |
Returns access denied page with dependence on current setting.
| |
GetFlagIconUrl |
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.) | |
GetImagePath |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetImageUrl |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetString |
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.) | |
GetValue(String) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
GetValue<ReturnType>(String, ReturnType) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
HasValue |
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.) | |
LoadUserControl |
Loads the user control based on the given path
(Inherited from AbstractUserControl.) | |
LogAndShowError |
Logs the exception and
(Inherited from AbstractUserControl.) | |
OnContentLoaded |
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.) | |
OnInit |
Init event handler.
(Inherited from AbstractUserControl.) | |
OnLoad |
Load event handler.
(Inherited from AbstractUserControl.) | |
OnPreRender |
PreRender event handler.
(Inherited from AbstractUserControl.) | |
RedirectToAccessDenied(String) |
Redirects the user to Access denied page.
| |
RedirectToAccessDenied(Int32, String) |
Redirects the user to Access denied page.
| |
RedirectToAccessDenied(String, String) |
Redirects the user to Access denied page.
| |
RedirectToInformation |
Redirects the user to the info page which displays specified message.
| |
RedirectToUIElementAccessDenied |
Redirects the user to Access denied page.
| |
RedirectToUINotAvailable |
Redirects the user to the info page which says that the UI of the requested page is not available.
| |
ReleaseContext |
Releases the control context.
| |
Render |
Render event handler.
(Inherited from AbstractUserControl.) | |
ResolveUrl |
Resolves the given URL
(Inherited from AbstractUserControl.) | |
SetContext |
Sets the control context.
| |
SetValue |
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.) | |
ShowChangesSaved |
Shows the general changes saved message.
(Inherited from AbstractUserControl.) | |
ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractUserControl.) | |
ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
TrackViewState |
Tracks the view state.
(Inherited from InlineUserControl.) |
Name | Description | |
---|---|---|
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.) | |
GetString |
Gets the string by the specified resource key
(Defined by ControlsExtensions.) |