CMSEditableImage Class

Editable image control.

Inheritance Hierarchy

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

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

Syntax

public class CMSEditableImage : CMSAbstractEditableControl, 
	INamingContainer

The CMSEditableImage type exposes the following members.

Constructors

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

Fields

	Name	Description
Protected field	imgImage	Image.
Protected field	lblError	Error label.
Protected field	lblTitle	Region title.
Protected field	mAlternateText	Alternate text.
Protected field	mDisplaySelectorTextBox	Display image selector text box.
Protected field	mImageCssClass	Image class.
Protected field	mImageStyle	Image style.
Protected field	mImageTitle	Image title.
Protected field	pnlEditor	Region panel.

Properties

	Name	Description
Public property	AlternateText	Alternative image text.
Public property	CheckPermissions	Gets or sets the value that indicates whether the permissions are checked. (Inherited from CMSAbstractEditableControl.)
Public property	DisplaySelectorTextBox	Display selector text box.
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	ImageControl	Returns instance of image control.
Public property	ImageCssClass	Image CssClass.
Public property	ImageHeight	Image height.
Public property	ImageStyle	Image Style.
Public property	ImageTitle	Control title which is displayed in the editable mode.
Public property	ImageWidth	Image width.
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	IsLiveSite	Indicates if control is used in live site mode.
Public property	PageManager	Page manager control. (Inherited from CMSAbstractEditableControl.)
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.)
Public property	ViewMode	Control view mode. (Inherited from CMSAbstractEditableControl.)

Methods

	Name	Description
Protected method	CreateChildControls	Creates the child control hierarchy. (Overrides Control.CreateChildControls().)
Public method	GetContent	Gets the current control content. (Overrides CMSAbstractEditableControl.GetContent().)
Protected method	GetContentID	Returns content identification for storage (Inherited from CMSAbstractEditableControl.)
Public method Static member	GetContentXml	Gets the image content XML
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 tag configuration for on-site editting. (Inherited from CMSAbstractEditableControl.)
Public method	GetSpellCheckFields	Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked. (Inherited from CMSAbstractEditableControl.)
Public method	IsValid	Returns true if entered data is valid. If data is invalid, it returns false and displays an error message. (Inherited from CMSAbstractEditableControl.)
Public method	LoadContent(String, Boolean)	Loads the control 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	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.)