| SettingsGroupViewerControl Class |
Base class for SettingsGroupViewer, so it is possible to connect to events on settings page.
Inheritance HierarchySystemObject
System.Web.UIControl
System.Web.UITemplateControl
System.Web.UIUserControl
CMS.ExtendedControlsAbstractUserControl
CMS.ExtendedControlsInlineUserControl
CMS.UIControlsCMSUserControl
CMS.UIControlsCMSAdminControl
CMS.UIControlsCMSAdminEditControl
CMS.UIControlsSettingsGroupViewerControl
System.Web.UIControl
System.Web.UITemplateControl
System.Web.UIUserControl
CMS.ExtendedControlsAbstractUserControl
CMS.ExtendedControlsInlineUserControl
CMS.UIControlsCMSUserControl
CMS.UIControlsCMSAdminControl
CMS.UIControlsCMSAdminEditControl
CMS.UIControlsSettingsGroupViewerControl
Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23
SyntaxC#
public abstract class SettingsGroupViewerControl : CMSAdminEditControl
The SettingsGroupViewerControl type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SettingsGroupViewerControl |
Methods| Name | Description | |
|---|---|---|
 | AccessDenied(String) |
Ensure access denied actions due to settings.
(Inherited from CMSAdminControl.) |
| AccessDenied(Int32, String) |
Ensure access denied actions due to settings.
(Inherited from CMSAdminControl.) |
| AccessDenied(String, String) |
Ensure access denied actions due to settings.
(Inherited from CMSAdminControl.) |
| 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.) |
| ClearForm |
Clears control.
(Inherited from CMSAdminControl.) |
| 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.) |
| EvalDouble |
Evaluates the item data and converts it to the integer.
(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.
(Inherited from CMSUserControl.) |
| 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 localized string.
(Inherited from AbstractUserControl.) |
| GetValue(String) |
Returns the value of the given property.
(Inherited from InlineUserControl.) |
| GetValueReturnType(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.) |
| CheckPermissions(String, String) |
Check permissions for specified resource and permission type, return false is user doesn't have permissions.
(Inherited from CMSAdminControl.) |
| CheckPermissions(String, String, Int32) |
Check permissions for specified resource and permission type, return false is user doesn't have permissions.
(Inherited from CMSAdminControl.) |
| CheckPermissions(String, String, String) |
Check permissions for specified resource and permission type, return false is user doesn't have permissions.
(Inherited from CMSAdminControl.) |
| 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 |
OnLoad override, setup access denied page with dependence on current usage.
(Inherited from CMSUserControl.) |
| OnPreRender |
PreRender event handler.
(Inherited from AbstractUserControl.) |
| RaiseOnCheckPermissions(String, CMSAdminControl) |
Raises the OnCheckPermissions event, returns true when event was fired.
(Inherited from CMSAdminControl.) |
| RaiseOnCheckPermissions(String, String, CMSAdminControl) |
Raises the OnCheckPermissions event, returns true when event was fired.
(Inherited from CMSAdminControl.) |
| RaiseOnNotAllowed |
Raises the OnNotAllowed event.
(Inherited from CMSAdminControl.) |
| RaiseOnSaved |
Raises the OnSaved event.
(Inherited from CMSAdminEditControl.) |
| RedirectToAccessDenied(String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) |
| RedirectToAccessDenied(Int32, String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) |
| RedirectToAccessDenied(String, String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) |
| RedirectToUIElementAccessDenied |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) |
| ReleaseContext |
Releases the control context.
(Inherited from CMSUserControl.) |
| ReloadData |
Reloads control data without force reload.
(Inherited from CMSAdminControl.) |
| ReloadData(Boolean) |
Reloads control data.
(Inherited from CMSAdminControl.) |
| Render |
Render event handler.
(Inherited from AbstractUserControl.) |
| ResolveUrl |
Resolves the given URL
(Inherited from AbstractUserControl.) |
| SetContext |
Sets the control context.
(Inherited from CMSUserControl.) |
| SetValue |
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.) |
| ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractUserControl.) |
| ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) |
| ShowChangesSaved |
Shows the general changes saved message.
(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.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) |
| 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.) |
| GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Fields| Name | Description | |
|---|---|---|
 | mAccessDeniedPage |
Access denied page
(Inherited from CMSUserControl.) |
| mCMSDeskAccessDeniedPage |
CMSDesk access denied page
(Inherited from CMSUserControl.) |
| mControlContext |
Control context
(Inherited from CMSUserControl.) |
| mControlGUID |
Control GUID
(Inherited from CMSUserControl.) |
| mDisplayMode |
Display mode
(Inherited from CMSUserControl.) |
| mErrorMessage |
Error message.
(Inherited from CMSAdminControl.) |
| mInfoMessage |
Information message.
(Inherited from CMSAdminControl.) |
| mRedirectToAccessDeniedPage |
Redirect to access denied if the access is not allowed.
(Inherited from CMSAdminControl.) |
| mRelativePath |
Relative path
(Inherited from CMSUserControl.) |
| mUseCMSDeskAccessDeniedPage |
Indicates whether CMSDesk access denied page should be used
(Inherited from CMSUserControl.) |
| mViewStateTracked |
If true, the ViewState has been already tracked.
(Inherited from InlineUserControl.) |
| properties |
Control properties.
(Inherited from InlineUserControl.) |
Properties| Name | Description | |
|---|---|---|
 | AccessDeniedPage |
Access denied page URL.
(Inherited from CMSAdminControl.) |
| ComponentName |
Component name
(Inherited from AbstractUserControl.) |
| ControlContext |
Control context.
(Inherited from CMSUserControl.) |
| ControlGUID |
Unique ID of the control within the given request.
(Inherited from CMSUserControl.) |
| CurrentDocument |
Current document
(Inherited from AbstractUserControl.) |
| CurrentPageInfo |
Current page info
(Inherited from AbstractUserControl.) |
| CurrentResolver |
Control's resolver
(Inherited from CMSUserControl.) |
| CurrentSite |
Current site
(Inherited from AbstractUserControl.) |
| CurrentUser |
Current user
(Inherited from AbstractUserControl.) |
| DisplayMode |
Gets or sets display mode of the control.
(Inherited from CMSUserControl.) |
| DocumentManager |
Document manager control
(Inherited from AbstractUserControl.) |
| EditedObject |
Control's edited object
(Inherited from AbstractUserControl.) |
| ErrorMessage |
Error message.
(Inherited from CMSAdminControl.) |
| HeaderActions |
Header actions control
(Inherited from AbstractUserControl.) |
| InfoMessage |
Information message.
(Inherited from CMSAdminControl.) |
| IsCMSDesk |
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.) |
| IsLiveSite |
Indicates if control is used on live site.
(Inherited from AbstractUserControl.) |
| Item |
Gets or sets the value of the column.
(Inherited from InlineUserControl.) |
| ItemGUID |
Item GUID.
(Inherited from CMSAdminEditControl.) |
| ItemID |
Item ID.
(Inherited from CMSAdminEditControl.) |
| MessagesPlaceHolder |
Placeholder for messages
(Inherited from AbstractUserControl.) |
| Parameter |
Control parameter.
(Inherited from InlineUserControl.) |
| RedirectToAccessDeniedPage |
Redirect to access denied if the access is not allowed.
(Inherited from CMSAdminControl.) |
| RelativePath |
Page relative path.
(Inherited from CMSUserControl.) |
| SettingsSave |
Event fires when settings keys are being saved.
|
| ShortID |
Short ID of the control.
(Inherited from AbstractUserControl.) |
| StopProcessing |
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.) |
| TypeName |
Returns the object type name.
(Inherited from CMSUserControl.) |
| UIContext |
Control's UI Context
(Inherited from AbstractUserControl.) |
| UseCMSDeskAccessDeniedPage |
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
(Inherited from CMSUserControl.) |
| UsesLocalMessagesPlaceHolder |
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.) |
 | ViewState |
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.) |
Events| Name | Description | |
|---|---|---|
 | OnCheckPermissions |
On check permissions event.
(Inherited from CMSAdminControl.) |
| OnCheckPermissionsExtended |
On check permissions event.
(Inherited from CMSAdminControl.) |
| OnNotAllowed |
On not allowed event.
(Inherited from CMSAdminControl.) |
| OnSaved |
Occurs when the edited object is saved.
(Inherited from CMSAdminEditControl.) |
See Also