CMSAbstractEditableControl Class

Abstract class for the editable controls (controls that needs to store the content within the document content).

Inheritance Hierarchy

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

Namespace: CMS.PortalEngine.Web.UI
Assembly: CMS.PortalEngine.Web.UI (in CMS.PortalEngine.Web.UI.dll) Version: 10.0.0

Syntax

public abstract class CMSAbstractEditableControl : WebControl, 
	ICMSEditableControl, ISpellCheckableControl

The CMSAbstractEditableControl type exposes the following members.

Constructors

	Name	Description
Protected method	CMSAbstractEditableControl	Constructor.

Properties

	Name	Description
Protected property	EditDialogWidth	Edit dialog width which will be opened for editing of the editable control. Used in On-site editing.
Protected property	EditPageUrl	Edit page url which will be used for editing of the editable control. Used in On-site editing.
Protected property	EmptyContent	Indicates whether the control contains any editable content
Public property	CheckPermissions	Gets or sets the value that indicates whether the permissions are checked.
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.
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.
Public property	PageManager	Page manager control.
Public property	SelectOnlyPublished	If set, only published content is displayed on a live site.
Protected property	SourcePageInfo	Gets the source page info
Public property	ViewMode	Control view mode.

Methods

	Name	Description
Public method	GetContent	Returns the current web part content.
Protected method	GetContentID	Returns content identification for storage
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"
Public method	GetSpellCheckFields	Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
Public method	IsValid	Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.
Public method	LoadContent(String, Boolean)	Loads the control content.
Public method	LoadContent(PageInfo, Boolean)	Load the content to the region, applies the InheritContent.
Protected method	Render	Renders the control to the specified HTML writer. (Overrides WebControl.Render(HtmlTextWriter).)
Public method Static member	RequestEditViewMode	Requests the view mode for the editable control
Protected method	ResolveMacros	Resolves the macros within current context.
Public method	SaveContent	Saves the control content.

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.)