Click or drag to resize
CMSAbstractEditableControl Class
Abstract class for the editable controls (controls that needs to store the content within the document content).
Inheritance Hierarchy

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 8.2.23
Syntax
C#
public abstract class CMSAbstractEditableControl : WebControl, 
	ICMSEditableControl

The CMSAbstractEditableControl type exposes the following members.

Constructors
  NameDescription
Public methodCMSAbstractEditableControl
Constructor.
Top
Methods
  NameDescription
Public methodGetContent
Returns the current web part content.
Protected methodGetContentID
Returns content identification for storage
Public methodGetEditDialogParameters
Gets the custom dialog parameters used in the On-site editing when opening the modal edit dialog. The url parameters are in the following format: "name=value"
Public methodGetSpellCheckFields
Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
Public methodIsValid
Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.
Public methodLoadContent(String, Boolean)
Loads the control content.
Public methodLoadContent(PageInfo, Boolean)
Load the content to the region, applies the InheritContent.
Protected methodRender
Renders the control to the specified HTML writer.
(Overrides WebControlRender(HtmlTextWriter).)
Public methodStatic memberRequestEditViewMode
Requests the view mode for the editable control
Protected methodResolveMacros
Resolves the macros within current context.
Public methodSaveContent
Saves the control content.
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
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 MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Properties
  NameDescription
Protected propertyEditDialogWidth
Edit dialog width which will be opened for editing of the editable control. Used in On-site editing.
Protected propertyEditPageUrl
Edit page url which will be used for editing of the editable control. Used in On-site editing.
Protected propertyEmptyContent
Indicates whether the control contains any editable content
Public propertyCheckPermissions
Gets or sets the value that indicates whether the permissions are checked.
Public propertyInheritContent
If set, the region uses the content inheritance. If the region content of the current document is empty then the content of the first non-empty parent is used. Note: The editable region does not combine content of the current document with the content of the parent documents.
Public propertyInstanceGUID
If set, the instance guid is used as a key for the editable control, making the content available on other documents which use the same page template with this control.
Public propertyPageManager
Page manager control.
Public propertySelectOnlyPublished
If set, only published content is displayed on a live site.
Protected propertySourcePageInfo
Gets the source page info
Public propertyViewMode
Control view mode.
Top
See Also