CMSEditableRegion Class

Editable region control for regular page templates text content.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.PortalEngine.Web.UI.CMSAbstractEditableControl
        CMS.DocumentEngine.Web.UI.CMSEditableRegion

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 12.0.0

Syntax

public class CMSEditableRegion : CMSAbstractEditableControl, 
	INamingContainer

The CMSEditableRegion type exposes the following members.

Constructors

	Name	Description
Public method	CMSEditableRegion()	Constructor.
Public method	CMSEditableRegion(IPageManager)	Constructor, initializes the parent portal manager.

Fields

	Name	Description
Protected field	lblError	Error label.
Protected field	lblTitle	Region title.
Protected field	ltlContent	Region content.
Protected field	mHtmlAreaToolbar	Html area toolbar name.
Protected field	mHtmlAreaToolbarLocation	Html area toolbar location.
Protected field	mHtmlEditor	HTMLEditor object.
Protected field	mUseStylesheet	If set to true HTML editor uses stylesheet.
Protected field	pnlEditor	Editor panel.
Protected field	txtValue	TextBox editor object.

Properties

	Name	Description
Public property	CheckPermissions	Gets or sets the value that indicates whether the permissions are checked. (Inherited from CMSAbstractEditableControl.)
Public property	DialogHeight	Height of the control. Max size can be MaxValue
Public property	DialogWidth	Width of the control. Max size can be MaxValue
Protected property	EditDialogWidth	Edit dialog width which will be opened for editing of the editable control. Used in On-site editing. (Inherited from CMSAbstractEditableControl.)
Protected property	EditPageUrl	Edit page url which will be used for editing of the editable control. Used in On-site editing. (Overrides CMSAbstractEditableControl.EditPageUrl.)
Protected property	EmptyContent	Indicates whether the control contains any editable content (Inherited from CMSAbstractEditableControl.)
Public property	Enabled	Control is enabled? (Overrides WebControl.Enabled.)
Public property	EnableViewState	Whether the control automatically saves its state for use in round-trips. (Overrides Control.EnableViewState.)
Public property	HtmlAreaToolbar	HTML editor toolbar set name.
Public property	HtmlAreaToolbarLocation	HTML editor toolbar location.
Public property	HtmlEditor	HTML editor object.
Public property	HTMLEditorCssStylesheet	HTML editor css stylesheet.
Public property	InheritContent	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 property	InstanceGUID	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 property	MaxLength	Maximum length of the content.
Public property	MinLength	Minimum length of the content.
Public property	PageManager	Page manager control. (Inherited from CMSAbstractEditableControl.)
Public property	RegionTitle	Control title which is displayed in the editable mode.
Public property	RegionType	Type of server control which is displayed in the editable region.
Public property	ResizeToHeight	Height the image should be automatically resized to after it is uploaded.
Public property	ResizeToMaxSideSize	Max side size the image should be automatically resized to after it is uploaded.
Public property	ResizeToWidth	Width the image should be automatically resized to after it is uploaded.
Public property	SelectOnlyPublished	If set, only published content is displayed on a live site. (Inherited from CMSAbstractEditableControl.)
Protected property	SourcePageInfo	Gets the source page info (Inherited from CMSAbstractEditableControl.)
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Overrides WebControl.TagKey.)
Public property	UseInlineMode	Indicates whether HTML editor is used in inline (no IFrame) mode.
Public property	UseStylesheet	If set to true HTML editor uses stylesheet.
Public property	ViewMode	Control view mode. (Inherited from CMSAbstractEditableControl.)
Public property	WordWrap	Wrap the text if using text area field.

Methods

	Name	Description
Protected method	ApplySettings	Creates child controls.
Protected method	CreateChildControls	Creates child controls. (Overrides Control.CreateChildControls().)
Public method	GetContent	Returns the editable region content. (Overrides CMSAbstractEditableControl.GetContent().)
Protected method	GetContentID	Returns content identification for storage (Inherited from CMSAbstractEditableControl.)
Public method	GetEditDialogParameters	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 CMSAbstractEditableControl.GetEditDialogParameters().)
Protected method	GetOnSiteTagConfiguration	Creates configuration for on-site editting. (Overrides CMSAbstractEditableControl.GetOnSiteTagConfiguration().)
Public method	GetSpellCheckFields	Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked. (Overrides CMSAbstractEditableControl.GetSpellCheckFields().)
Public method	IsValid	Returns true if entered data is valid. If data is invalid, it returns false and displays an error message. (Overrides CMSAbstractEditableControl.IsValid().)
Public method	LoadContent(String, Boolean)	Loads the region content. (Overrides CMSAbstractEditableControl.LoadContent(String, Boolean).)
Public method	LoadContent(PageInfo, Boolean)	Load the content to the region, applies the InheritContent. (Inherited from CMSAbstractEditableControl.)
Protected method	OnLoad	Load event handler. (Overrides Control.OnLoad(EventArgs).)
Protected method	OnPreRender	PreRender event handler. (Overrides Control.OnPreRender(EventArgs).)
Protected method	Render	Renders the control. (Overrides CMSAbstractEditableControl.Render(HtmlTextWriter).)
Protected method	ResolveMacros	Resolves the macros within current context. (Inherited from CMSAbstractEditableControl.)
Public method	SaveContent	Saves the control content. (Inherited from CMSAbstractEditableControl.)

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	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.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)