Click or drag to resize
CMSEditableRegion Class
Editable region control for regular page templates text content.
Inheritance Hierarchy

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 11.0.0
Syntax
C#
public class CMSEditableRegion : CMSAbstractEditableControl, 
	INamingContainer

The CMSEditableRegion type exposes the following members.

Constructors
  NameDescription
Public methodCMSEditableRegion
Constructor.
Public methodCMSEditableRegion(IPageManager)
Constructor, initializes the parent portal manager.
Top
Fields
  NameDescription
Protected fieldlblError
Error label.
Protected fieldlblTitle
Region title.
Protected fieldltlContent
Region content.
Protected fieldmHtmlAreaToolbar
Html area toolbar name.
Protected fieldmHtmlAreaToolbarLocation
Html area toolbar location.
Protected fieldmHtmlEditor
HTMLEditor object.
Protected fieldmUseStylesheet
If set to true HTML editor uses stylesheet.
Protected fieldpnlEditor
Editor panel.
Protected fieldtxtValue
TextBox editor object.
Top
Properties
  NameDescription
Public propertyCheckPermissions
Gets or sets the value that indicates whether the permissions are checked.
(Inherited from CMSAbstractEditableControl.)
Public propertyDialogHeight
Height of the control. Max size can be MaxValue
Public propertyDialogWidth
Width of the control. Max size can be MaxValue
Protected propertyEditDialogWidth
Edit dialog width which will be opened for editing of the editable control. Used in On-site editing.
(Inherited from CMSAbstractEditableControl.)
Protected propertyEditPageUrl
Edit page url which will be used for editing of the editable control. Used in On-site editing.
(Overrides CMSAbstractEditableControlEditPageUrl.)
Protected propertyEmptyContent
Indicates whether the control contains any editable content
(Inherited from CMSAbstractEditableControl.)
Public propertyEnabled
Control is enabled?
(Overrides WebControlEnabled.)
Public propertyEnableViewState
Whether the control automatically saves its state for use in round-trips.
(Overrides ControlEnableViewState.)
Public propertyHtmlAreaToolbar
HTML editor toolbar set name.
Public propertyHtmlAreaToolbarLocation
HTML editor toolbar location.
Public propertyHtmlEditor
HTML editor object.
Public propertyHTMLEditorCssStylesheet
HTML editor css stylesheet.
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.
(Inherited from CMSAbstractEditableControl.)
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.
(Inherited from CMSAbstractEditableControl.)
Public propertyMaxLength
Maximum length of the content.
Public propertyMinLength
Minimum length of the content.
Public propertyPageManager
Page manager control.
(Inherited from CMSAbstractEditableControl.)
Public propertyRegionTitle
Control title which is displayed in the editable mode.
Public propertyRegionType
Type of server control which is displayed in the editable region.
Public propertyResizeToHeight
Height the image should be automatically resized to after it is uploaded.
Public propertyResizeToMaxSideSize
Max side size the image should be automatically resized to after it is uploaded.
Public propertyResizeToWidth
Width the image should be automatically resized to after it is uploaded.
Public propertySelectOnlyPublished
If set, only published content is displayed on a live site.
(Inherited from CMSAbstractEditableControl.)
Protected propertySourcePageInfo
Gets the source page info
(Inherited from CMSAbstractEditableControl.)
Protected propertyTagKey
Overrides the generation of the SPAN tag with custom tag.
(Overrides WebControlTagKey.)
Public propertyUseInlineMode
Indicates whether HTML editor is used in inline (no IFrame) mode.
Public propertyUseStylesheet
If set to true HTML editor uses stylesheet.
Public propertyViewMode
Control view mode.
(Inherited from CMSAbstractEditableControl.)
Public propertyWordWrap
Wrap the text if using text area field.
Top
Methods
  NameDescription
Protected methodApplySettings
Creates child controls.
Protected methodCreateChildControls
Creates child controls.
(Overrides ControlCreateChildControls.)
Public methodGetContent
Returns the editable region content.
(Overrides CMSAbstractEditableControlGetContent.)
Protected methodGetContentID
Returns content identification for storage
(Inherited from CMSAbstractEditableControl.)
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"
(Overrides CMSAbstractEditableControlGetEditDialogParameters.)
Public methodGetSpellCheckFields
Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
(Overrides CMSAbstractEditableControlGetSpellCheckFields.)
Public methodIsValid
Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.
(Overrides CMSAbstractEditableControlIsValid.)
Public methodLoadContent(String, Boolean)
Loads the region content.
(Overrides CMSAbstractEditableControlLoadContent(String, Boolean).)
Public methodLoadContent(PageInfo, Boolean)
Load the content to the region, applies the InheritContent.
(Inherited from CMSAbstractEditableControl.)
Protected methodOnLoad
Load event handler.
(Overrides ControlOnLoad(EventArgs).)
Protected methodOnPreRender
PreRender event handler.
(Overrides ControlOnPreRender(EventArgs).)
Protected methodRender
Renders the control.
(Overrides CMSAbstractEditableControlRender(HtmlTextWriter).)
Protected methodResolveMacros
Resolves the macros within current context.
(Inherited from CMSAbstractEditableControl.)
Public methodSaveContent
Saves the control content.
(Inherited from CMSAbstractEditableControl.)
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 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 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 ControlsExtensions.)
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.)
Top
See Also